api.md

Datastores

Types:

• CreateDatastoreResponse
• Datastore
• DatastoreMetadata
• ListDatastoresResponse
• DatastoreDeleteResponse

Methods:

• client.datastores.create({ ...params }) -> CreateDatastoreResponse
• client.datastores.list({ ...params }) -> DatastoresDatastoresPage
• client.datastores.delete(datastoreId) -> unknown
• client.datastores.metadata(datastoreId) -> DatastoreMetadata

Documents

Types:

• CompositeMetadataFilter
• DocumentMetadata
• IngestionResponse
• ListDocumentsResponse
• DocumentDeleteResponse

Methods:

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

Agents

Types:

• Agent
• AgentMetadata
• CreateAgentOutput
• ListAgentsResponse
• AgentUpdateResponse
• AgentDeleteResponse

Methods:

• client.agents.create({ ...params }) -> CreateAgentOutput
• client.agents.update(agentId, { ...params }) -> unknown
• client.agents.list({ ...params }) -> AgentsPage
• client.agents.delete(agentId) -> unknown
• client.agents.metadata(agentId) -> AgentMetadata

Query

Types:

• QueryResponse
• RetrievalInfoResponse
• QueryFeedbackResponse
• QueryMetricsResponse

Methods:

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

Evaluate

Types:

• CreateEvaluationResponse

Methods:

• client.agents.evaluate.create(agentId, { ...params }) -> CreateEvaluationResponse

Jobs

Types:

• EvaluationJobMetadata
• ListEvaluationJobsResponse
• JobCancelResponse

Methods:

• client.agents.evaluate.jobs.list(agentId) -> ListEvaluationJobsResponse
• client.agents.evaluate.jobs.cancel(agentId, jobId) -> unknown
• client.agents.evaluate.jobs.metadata(agentId, jobId) -> EvaluationJobMetadata

Datasets

Types:

• CreateDatasetResponse
• DatasetMetadata
• ListDatasetsResponse

Tune

Types:

• TuneDeleteResponse

Methods:

• client.agents.datasets.tune.create(agentId, { ...params }) -> CreateDatasetResponse
• client.agents.datasets.tune.retrieve(agentId, datasetName, { ...params }) -> Response
• client.agents.datasets.tune.update(agentId, datasetName, { ...params }) -> CreateDatasetResponse
• client.agents.datasets.tune.list(agentId, { ...params }) -> ListDatasetsResponse
• client.agents.datasets.tune.delete(agentId, datasetName) -> unknown
• client.agents.datasets.tune.metadata(agentId, datasetName, { ...params }) -> DatasetMetadata

Evaluate

Types:

• EvaluateDeleteResponse

Methods:

• client.agents.datasets.evaluate.create(agentId, { ...params }) -> CreateDatasetResponse
• client.agents.datasets.evaluate.retrieve(agentId, datasetName, { ...params }) -> Response
• client.agents.datasets.evaluate.update(agentId, datasetName, { ...params }) -> CreateDatasetResponse
• client.agents.datasets.evaluate.list(agentId, { ...params }) -> ListDatasetsResponse
• client.agents.datasets.evaluate.delete(agentId, datasetName) -> unknown
• client.agents.datasets.evaluate.metadata(agentId, datasetName, { ...params }) -> DatasetMetadata

Tune

Types:

• CreateTuneResponse

Methods:

• client.agents.tune.create(agentId, { ...params }) -> CreateTuneResponse

Jobs

Types:

• ListTuneJobsResponse
• TuneJobMetadata
• JobDeleteResponse

Methods:

• client.agents.tune.jobs.list(agentId) -> ListTuneJobsResponse
• client.agents.tune.jobs.delete(agentId, jobId) -> unknown
• client.agents.tune.jobs.metadata(agentId, jobId) -> TuneJobMetadata

Models

Types:

• ListTuneModelsResponse

Methods:

• client.agents.tune.models.list(agentId) -> ListTuneModelsResponse

Users

Types:

• InviteUsersResponse
• ListUsersResponse
• NewUser
• UserUpdateResponse
• UserDeactivateResponse

Methods:

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

LMUnit

Types:

• LMUnitCreateResponse

Methods:

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

Rerank

Types:

• RerankCreateResponse

Methods:

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

Generate

Types:

• GenerateCreateResponse

Methods:

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