api.md

Shared Types

from contextual.types import ParsedBlock

Datastores

Types:

from contextual.types import (
    ChunkingConfiguration,
    CreateDatastoreResponse,
    Datastore,
    DatastoreMetadata,
    DatastoreParseConfiguration,
    HTMLConfiguration,
    ListDatastoresResponse,
    UnstructuredDatastoreConfigModel,
    DatastoreUpdateResponse,
    DatastoreDeleteResponse,
    DatastoreResetResponse,
)

Methods:

• client.datastores.create(**params) -> CreateDatastoreResponse
• client.datastores.update(datastore_id, **params) -> DatastoreUpdateResponse
• client.datastores.list(**params) -> SyncDatastoresPage[Datastore]
• client.datastores.delete(datastore_id) -> DatastoreDeleteResponse
• client.datastores.metadata(datastore_id) -> DatastoreMetadata
• client.datastores.reset(datastore_id) -> DatastoreResetResponse

Documents

Types:

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

Methods:

• client.datastores.documents.list(datastore_id, **params) -> SyncDocumentsPage[DocumentMetadata]
• client.datastores.documents.delete(document_id, *, datastore_id) -> DocumentDeleteResponse
• client.datastores.documents.get_parse_result(document_id, *, datastore_id, **params) -> DocumentGetParseResultResponse
• 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

Contents

Types:

from contextual.types.datastores import ContentListResponse, ContentMetadataResponse

Methods:

• client.datastores.contents.list(datastore_id, **params) -> SyncContentsPage[ContentListResponse]
• client.datastores.contents.metadata(content_id, *, datastore_id, **params) -> ContentMetadataResponse

Chunks

Types:

from contextual.types.datastores import ChunkUpdateContentResponse

Methods:

• client.datastores.chunks.update_content(content_id, *, datastore_id, **params) -> ChunkUpdateContentResponse

Agents

Types:

from contextual.types import (
    ACLConfig,
    Agent,
    AgentConfigs,
    AgentMetadata,
    CreateAgentOutput,
    FilterAndRerankConfig,
    GenerateResponseConfig,
    GlobalConfig,
    ListAgentsResponse,
    ReformulationConfig,
    RetrievalConfig,
    TranslationConfig,
    AgentUpdateResponse,
    AgentDeleteResponse,
    AgentMetadataResponse,
)

Methods:

• client.agents.create(**params) -> CreateAgentOutput
• client.agents.update(agent_id, **params) -> AgentUpdateResponse
• client.agents.list(**params) -> SyncPage[Agent]
• client.agents.delete(agent_id) -> AgentDeleteResponse
• client.agents.copy(agent_id) -> CreateAgentOutput
• client.agents.metadata(agent_id) -> AgentMetadataResponse
• client.agents.reset(agent_id) -> object
• client.agents.save_template(agent_id, **params) -> object

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) -> QueryFeedbackResponse
• client.agents.query.metrics(agent_id, **params) -> QueryMetricsResponse
• client.agents.query.retrieval_info(message_id, *, agent_id, **params) -> RetrievalInfoResponse

Templates

Types:

from contextual.types.agents import TemplateListResponse

Methods:

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

Users

Types:

from contextual.types import InviteUsersResponse, ListUsersResponse, NewUser

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

Parse

Types:

from contextual.types import (
    ParseCreateResponse,
    ParseJobResultsResponse,
    ParseJobStatusResponse,
    ParseJobsResponse,
)

Methods:

• client.parse.create(**params) -> ParseCreateResponse
• client.parse.job_results(job_id, **params) -> ParseJobResultsResponse
• client.parse.job_status(job_id) -> ParseJobStatusResponse
• client.parse.jobs(**params) -> ParseJobsResponse