api.md

Datastores

Types:

from contextual.types import (
    CreateDatastoreResponse,
    Datastore,
    DatastoreMetadata,
    ListDatastoresResponse,
    DatastoreDeleteResponse,
)

Methods:

• client.datastores.create(**params) -> CreateDatastoreResponse
• client.datastores.list(**params) -> SyncDatastoresPage[Datastore]
• client.datastores.delete(datastore_id) -> object
• client.datastores.metadata(datastore_id) -> DatastoreMetadata

Documents

Types:

from contextual.types.datastores import (
    CompositeMetadataFilter,
    DocumentMetadata,
    IngestionResponse,
    ListDocumentsResponse,
    DocumentDeleteResponse,
)

Methods:

• client.datastores.documents.list(datastore_id, **params) -> SyncDocumentsPage[DocumentMetadata]
• client.datastores.documents.delete(document_id, *, datastore_id) -> object
• client.datastores.documents.ingest(datastore_id, **params) -> IngestionResponse
• client.datastores.documents.metadata(document_id, *, datastore_id) -> DocumentMetadata
• client.datastores.documents.set_metadata(document_id, *, datastore_id, **params) -> DocumentMetadata

Agents

Types:

from contextual.types import (
    Agent,
    AgentMetadata,
    CreateAgentOutput,
    ListAgentsResponse,
    AgentUpdateResponse,
    AgentDeleteResponse,
)

Methods:

• client.agents.create(**params) -> CreateAgentOutput
• client.agents.update(agent_id, **params) -> object
• client.agents.list(**params) -> SyncPage[Agent]
• client.agents.delete(agent_id) -> object
• client.agents.metadata(agent_id) -> AgentMetadata

Query

Types:

from contextual.types.agents import (
    QueryResponse,
    RetrievalInfoResponse,
    QueryFeedbackResponse,
    QueryMetricsResponse,
)

Methods:

• client.agents.query.create(agent_id, **params) -> QueryResponse
• client.agents.query.feedback(agent_id, **params) -> object
• client.agents.query.metrics(agent_id, **params) -> QueryMetricsResponse
• client.agents.query.retrieval_info(message_id, *, agent_id, **params) -> RetrievalInfoResponse

Evaluate

Types:

from contextual.types.agents import CreateEvaluationResponse

Methods:

• client.agents.evaluate.create(agent_id, **params) -> CreateEvaluationResponse

Jobs

Types:

from contextual.types.agents.evaluate import (
    EvaluationJobMetadata,
    ListEvaluationJobsResponse,
    JobCancelResponse,
)

Methods:

• client.agents.evaluate.jobs.list(agent_id) -> ListEvaluationJobsResponse
• client.agents.evaluate.jobs.cancel(job_id, *, agent_id) -> object
• client.agents.evaluate.jobs.metadata(job_id, *, agent_id) -> EvaluationJobMetadata

Datasets

Types:

from contextual.types.agents import CreateDatasetResponse, DatasetMetadata, ListDatasetsResponse

Tune

Types:

from contextual.types.agents.datasets import TuneDeleteResponse

Methods:

• client.agents.datasets.tune.create(agent_id, **params) -> CreateDatasetResponse
• client.agents.datasets.tune.retrieve(dataset_name, *, agent_id, **params) -> BinaryAPIResponse
• client.agents.datasets.tune.update(dataset_name, *, agent_id, **params) -> CreateDatasetResponse
• client.agents.datasets.tune.list(agent_id, **params) -> ListDatasetsResponse
• client.agents.datasets.tune.delete(dataset_name, *, agent_id) -> object
• client.agents.datasets.tune.metadata(dataset_name, *, agent_id, **params) -> DatasetMetadata

Evaluate

Types:

from contextual.types.agents.datasets import EvaluateDeleteResponse

Methods:

• client.agents.datasets.evaluate.create(agent_id, **params) -> CreateDatasetResponse
• client.agents.datasets.evaluate.retrieve(dataset_name, *, agent_id, **params) -> BinaryAPIResponse
• client.agents.datasets.evaluate.update(dataset_name, *, agent_id, **params) -> CreateDatasetResponse
• client.agents.datasets.evaluate.list(agent_id, **params) -> ListDatasetsResponse
• client.agents.datasets.evaluate.delete(dataset_name, *, agent_id) -> object
• client.agents.datasets.evaluate.metadata(dataset_name, *, agent_id, **params) -> DatasetMetadata

Tune

Types:

from contextual.types.agents import CreateTuneResponse

Methods:

• client.agents.tune.create(agent_id, **params) -> CreateTuneResponse

Jobs

Types:

from contextual.types.agents.tune import ListTuneJobsResponse, TuneJobMetadata, JobDeleteResponse

Methods:

• client.agents.tune.jobs.list(agent_id) -> ListTuneJobsResponse
• client.agents.tune.jobs.delete(job_id, *, agent_id) -> object
• client.agents.tune.jobs.metadata(job_id, *, agent_id) -> TuneJobMetadata

Models

Types:

from contextual.types.agents.tune import ListTuneModelsResponse

Methods:

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

Users

Types:

from contextual.types import (
    InviteUsersResponse,
    ListUsersResponse,
    NewUser,
    UserUpdateResponse,
    UserDeactivateResponse,
)

Methods:

• client.users.update(**params) -> object
• client.users.list(**params) -> SyncUsersPage[User]
• client.users.deactivate(**params) -> object
• client.users.invite(**params) -> InviteUsersResponse

LMUnit

Types:

from contextual.types import LMUnitCreateResponse

Methods:

• client.lmunit.create(**params) -> LMUnitCreateResponse

Rerank

Types:

from contextual.types import RerankCreateResponse

Methods:

• client.rerank.create(**params) -> RerankCreateResponse

Generate

Types:

from contextual.types import GenerateCreateResponse

Methods:

• client.generate.create(**params) -> GenerateCreateResponse