Skip to content

Latest commit

 

History

History
196 lines (134 loc) · 11.6 KB

api.md

File metadata and controls

196 lines (134 loc) · 11.6 KB

Shared

Types:

Datastores

Types:

Methods:

  • client.datastores.create({ ...params }) -> CreateDatastoreResponse
  • client.datastores.update(datastoreId, { ...params }) -> DatastoreUpdateResponse
  • client.datastores.list({ ...params }) -> DatastoresDatastoresPage
  • client.datastores.delete(datastoreId) -> DatastoreDeleteResponse
  • client.datastores.metadata(datastoreId) -> DatastoreMetadata
  • client.datastores.reset(datastoreId) -> DatastoreResetResponse

Documents

Types:

Methods:

  • client.datastores.documents.list(datastoreId, { ...params }) -> DocumentMetadataDocumentsPage
  • client.datastores.documents.delete(datastoreId, documentId) -> DocumentDeleteResponse
  • client.datastores.documents.getParseResult(datastoreId, documentId, { ...params }) -> DocumentGetParseResultResponse
  • client.datastores.documents.ingest(datastoreId, { ...params }) -> IngestionResponse
  • client.datastores.documents.metadata(datastoreId, documentId) -> DocumentMetadata
  • client.datastores.documents.setMetadata(datastoreId, documentId, { ...params }) -> DocumentMetadata

Contents

Types:

Methods:

  • client.datastores.contents.list(datastoreId, { ...params }) -> ContentListResponsesContentsPage
  • client.datastores.contents.metadata(datastoreId, contentId, { ...params }) -> ContentMetadataResponse

Chunks

Types:

Methods:

  • client.datastores.chunks.updateContent(datastoreId, contentId, { ...params }) -> ChunkUpdateContentResponse

Agents

Types:

Methods:

  • client.agents.create({ ...params }) -> CreateAgentOutput
  • client.agents.update(agentId, { ...params }) -> AgentUpdateResponse
  • client.agents.list({ ...params }) -> AgentsPage
  • client.agents.delete(agentId) -> AgentDeleteResponse
  • client.agents.copy(agentId) -> CreateAgentOutput
  • client.agents.metadata(agentId) -> AgentMetadataResponse
  • client.agents.reset(agentId) -> unknown
  • client.agents.saveTemplate(agentId, { ...params }) -> unknown

Query

Types:

Methods:

  • client.agents.query.create(agentId, { ...params }) -> QueryResponse
  • client.agents.query.feedback(agentId, { ...params }) -> QueryFeedbackResponse
  • client.agents.query.metrics(agentId, { ...params }) -> QueryMetricsResponse
  • client.agents.query.retrievalInfo(agentId, messageId, { ...params }) -> RetrievalInfoResponse

Templates

Types:

Methods:

  • client.agents.templates.retrieve(template) -> AgentMetadata
  • client.agents.templates.list() -> TemplateListResponse

Users

Types:

Methods:

  • client.users.update({ ...params }) -> unknown
  • client.users.list({ ...params }) -> ListUsersResponseUsersUsersPage
  • client.users.deactivate({ ...params }) -> unknown
  • client.users.invite({ ...params }) -> InviteUsersResponse

LMUnit

Types:

Methods:

  • client.lmUnit.create({ ...params }) -> LMUnitCreateResponse

Rerank

Types:

Methods:

  • client.rerank.create({ ...params }) -> RerankCreateResponse

Generate

Types:

Methods:

  • client.generate.create({ ...params }) -> GenerateCreateResponse

Parse

Types:

Methods:

  • client.parse.create({ ...params }) -> ParseCreateResponse
  • client.parse.jobResults(jobId, { ...params }) -> ParseJobResultsResponse
  • client.parse.jobStatus(jobId) -> ParseJobStatusResponse
  • client.parse.jobs({ ...params }) -> ParseJobsResponse