1+ # Shared Types
2+
3+ ``` python
4+ from contextual.types import ParsedBlock
5+ ```
6+
17# Datastores
28
39Types:
410
511``` python
612from contextual.types import (
13+ ChunkingConfiguration,
714 CreateDatastoreResponse,
815 Datastore,
916 DatastoreMetadata,
17+ DatastoreParseConfiguration,
18+ HTMLConfiguration,
1019 ListDatastoresResponse,
20+ UnstructuredDatastoreConfigModel,
1121 DatastoreUpdateResponse,
22+ DatastoreDeleteResponse,
23+ DatastoreResetResponse,
1224)
1325```
1426
@@ -17,9 +29,9 @@ Methods:
1729- <code title =" post /datastores " >client.datastores.<a href =" ./src/contextual/resources/datastores/datastores.py " >create</a >(\*\* <a href =" src/contextual/types/datastore_create_params.py " >params</a >) -> <a href =" ./src/contextual/types/create_datastore_response.py " >CreateDatastoreResponse</a ></code >
1830- <code title =" put /datastores/{datastore_id} " >client.datastores.<a href =" ./src/contextual/resources/datastores/datastores.py " >update</a >(datastore_id, \*\* <a href =" src/contextual/types/datastore_update_params.py " >params</a >) -> <a href =" ./src/contextual/types/datastore_update_response.py " >DatastoreUpdateResponse</a ></code >
1931- <code title =" get /datastores " >client.datastores.<a href =" ./src/contextual/resources/datastores/datastores.py " >list</a >(\*\* <a href =" src/contextual/types/datastore_list_params.py " >params</a >) -> <a href =" ./src/contextual/types/datastore.py " >SyncDatastoresPage[ Datastore] </a ></code >
20- - <code title =" delete /datastores/{datastore_id} " >client.datastores.<a href =" ./src/contextual/resources/datastores/datastores.py " >delete</a >(datastore_id) -> object </code >
32+ - <code title =" delete /datastores/{datastore_id} " >client.datastores.<a href =" ./src/contextual/resources/datastores/datastores.py " >delete</a >(datastore_id) -> < a href = " ./src/contextual/types/datastore_delete_response.py " >DatastoreDeleteResponse</ a > </code >
2133- <code title =" get /datastores/{datastore_id}/metadata " >client.datastores.<a href =" ./src/contextual/resources/datastores/datastores.py " >metadata</a >(datastore_id) -> <a href =" ./src/contextual/types/datastore_metadata.py " >DatastoreMetadata</a ></code >
22- - <code title =" put /datastores/{datastore_id}/reset " >client.datastores.<a href =" ./src/contextual/resources/datastores/datastores.py " >reset</a >(datastore_id) -> object </code >
34+ - <code title =" put /datastores/{datastore_id}/reset " >client.datastores.<a href =" ./src/contextual/resources/datastores/datastores.py " >reset</a >(datastore_id) -> < a href = " ./src/contextual/types/datastore_reset_response.py " >DatastoreResetResponse</ a > </code >
2335
2436## Documents
2537
@@ -32,14 +44,15 @@ from contextual.types.datastores import (
3244 DocumentMetadata,
3345 IngestionResponse,
3446 ListDocumentsResponse,
47+ DocumentDeleteResponse,
3548 DocumentGetParseResultResponse,
3649)
3750```
3851
3952Methods:
4053
4154- <code title =" get /datastores/{datastore_id}/documents " >client.datastores.documents.<a href =" ./src/contextual/resources/datastores/documents.py " >list</a >(datastore_id, \*\* <a href =" src/contextual/types/datastores/document_list_params.py " >params</a >) -> <a href =" ./src/contextual/types/datastores/document_metadata.py " >SyncDocumentsPage[ DocumentMetadata] </a ></code >
42- - <code title =" delete /datastores/{datastore_id}/documents/{document_id} " >client.datastores.documents.<a href =" ./src/contextual/resources/datastores/documents.py " >delete</a >(document_id, \* , datastore_id) -> object </code >
55+ - <code title =" delete /datastores/{datastore_id}/documents/{document_id} " >client.datastores.documents.<a href =" ./src/contextual/resources/datastores/documents.py " >delete</a >(document_id, \* , datastore_id) -> < a href = " ./src/contextual/types/datastores/document_delete_response.py " >DocumentDeleteResponse</ a > </code >
4356- <code title =" get /datastores/{datastore_id}/documents/{document_id}/parse " >client.datastores.documents.<a href =" ./src/contextual/resources/datastores/documents.py " >get_parse_result</a >(document_id, \* , datastore_id, \*\* <a href =" src/contextual/types/datastores/document_get_parse_result_params.py " >params</a >) -> <a href =" ./src/contextual/types/datastores/document_get_parse_result_response.py " >DocumentGetParseResultResponse</a ></code >
4457- <code title =" post /datastores/{datastore_id}/documents " >client.datastores.documents.<a href =" ./src/contextual/resources/datastores/documents.py " >ingest</a >(datastore_id, \*\* <a href =" src/contextual/types/datastores/document_ingest_params.py " >params</a >) -> <a href =" ./src/contextual/types/datastores/ingestion_response.py " >IngestionResponse</a ></code >
4558- <code title =" get /datastores/{datastore_id}/documents/{document_id}/metadata " >client.datastores.documents.<a href =" ./src/contextual/resources/datastores/documents.py " >metadata</a >(document_id, \* , datastore_id) -> <a href =" ./src/contextual/types/datastores/document_metadata.py " >DocumentMetadata</a ></code >
@@ -58,12 +71,25 @@ Methods:
5871- <code title =" get /datastores/{datastore_id}/contents " >client.datastores.contents.<a href =" ./src/contextual/resources/datastores/contents.py " >list</a >(datastore_id, \*\* <a href =" src/contextual/types/datastores/content_list_params.py " >params</a >) -> <a href =" ./src/contextual/types/datastores/content_list_response.py " >SyncContentsPage[ ContentListResponse] </a ></code >
5972- <code title =" get /datastores/{datastore_id}/contents/{content_id}/metadata " >client.datastores.contents.<a href =" ./src/contextual/resources/datastores/contents.py " >metadata</a >(content_id, \* , datastore_id, \*\* <a href =" src/contextual/types/datastores/content_metadata_params.py " >params</a >) -> <a href =" ./src/contextual/types/datastores/content_metadata_response.py " >ContentMetadataResponse</a ></code >
6073
74+ ## Chunks
75+
76+ Types:
77+
78+ ``` python
79+ from contextual.types.datastores import ChunkUpdateContentResponse
80+ ```
81+
82+ Methods:
83+
84+ - <code title =" put /datastores/{datastore_id}/chunks/{content_id}/content " >client.datastores.chunks.<a href =" ./src/contextual/resources/datastores/chunks.py " >update_content</a >(content_id, \* , datastore_id, \*\* <a href =" src/contextual/types/datastores/chunk_update_content_params.py " >params</a >) -> <a href =" ./src/contextual/types/datastores/chunk_update_content_response.py " >ChunkUpdateContentResponse</a ></code >
85+
6186# Agents
6287
6388Types:
6489
6590``` python
6691from contextual.types import (
92+ ACLConfig,
6793 Agent,
6894 AgentConfigs,
6995 AgentMetadata,
@@ -72,20 +98,25 @@ from contextual.types import (
7298 GenerateResponseConfig,
7399 GlobalConfig,
74100 ListAgentsResponse,
101+ ReformulationConfig,
75102 RetrievalConfig,
103+ TranslationConfig,
104+ AgentUpdateResponse,
105+ AgentDeleteResponse,
76106 AgentMetadataResponse,
77107)
78108```
79109
80110Methods:
81111
82112- <code title =" post /agents " >client.agents.<a href =" ./src/contextual/resources/agents/agents.py " >create</a >(\*\* <a href =" src/contextual/types/agent_create_params.py " >params</a >) -> <a href =" ./src/contextual/types/create_agent_output.py " >CreateAgentOutput</a ></code >
83- - <code title =" put /agents/{agent_id} " >client.agents.<a href =" ./src/contextual/resources/agents/agents.py " >update</a >(agent_id, \*\* <a href =" src/contextual/types/agent_update_params.py " >params</a >) -> object </code >
113+ - <code title =" put /agents/{agent_id} " >client.agents.<a href =" ./src/contextual/resources/agents/agents.py " >update</a >(agent_id, \*\* <a href =" src/contextual/types/agent_update_params.py " >params</a >) -> < a href = " ./src/contextual/types/agent_update_response.py " >AgentUpdateResponse</ a > </code >
84114- <code title =" get /agents " >client.agents.<a href =" ./src/contextual/resources/agents/agents.py " >list</a >(\*\* <a href =" src/contextual/types/agent_list_params.py " >params</a >) -> <a href =" ./src/contextual/types/agent.py " >SyncPage[ Agent] </a ></code >
85- - <code title =" delete /agents/{agent_id} " >client.agents.<a href =" ./src/contextual/resources/agents/agents.py " >delete</a >(agent_id) -> object </code >
115+ - <code title =" delete /agents/{agent_id} " >client.agents.<a href =" ./src/contextual/resources/agents/agents.py " >delete</a >(agent_id) -> < a href = " ./src/contextual/types/agent_delete_response.py " >AgentDeleteResponse</ a > </code >
86116- <code title =" post /agents/{agent_id}/copy " >client.agents.<a href =" ./src/contextual/resources/agents/agents.py " >copy</a >(agent_id) -> <a href =" ./src/contextual/types/create_agent_output.py " >CreateAgentOutput</a ></code >
87117- <code title =" get /agents/{agent_id}/metadata " >client.agents.<a href =" ./src/contextual/resources/agents/agents.py " >metadata</a >(agent_id) -> <a href =" ./src/contextual/types/agent_metadata_response.py " >AgentMetadataResponse</a ></code >
88118- <code title =" put /agents/{agent_id}/reset " >client.agents.<a href =" ./src/contextual/resources/agents/agents.py " >reset</a >(agent_id) -> object</code >
119+ - <code title =" post /agents/{agent_id}/template " >client.agents.<a href =" ./src/contextual/resources/agents/agents.py " >save_template</a >(agent_id, \*\* <a href =" src/contextual/types/agent_save_template_params.py " >params</a >) -> object</code >
89120
90121## Query
91122
@@ -107,6 +138,19 @@ Methods:
107138- <code title =" get /agents/{agent_id}/metrics " >client.agents.query.<a href =" ./src/contextual/resources/agents/query.py " >metrics</a >(agent_id, \*\* <a href =" src/contextual/types/agents/query_metrics_params.py " >params</a >) -> <a href =" ./src/contextual/types/agents/query_metrics_response.py " >QueryMetricsResponse</a ></code >
108139- <code title =" get /agents/{agent_id}/query/{message_id}/retrieval/info " >client.agents.query.<a href =" ./src/contextual/resources/agents/query.py " >retrieval_info</a >(message_id, \* , agent_id, \*\* <a href =" src/contextual/types/agents/query_retrieval_info_params.py " >params</a >) -> <a href =" ./src/contextual/types/agents/retrieval_info_response.py " >RetrievalInfoResponse</a ></code >
109140
141+ ## Templates
142+
143+ Types:
144+
145+ ``` python
146+ from contextual.types.agents import TemplateListResponse
147+ ```
148+
149+ Methods:
150+
151+ - <code title =" get /agents/templates/{template} " >client.agents.templates.<a href =" ./src/contextual/resources/agents/templates.py " >retrieve</a >(template) -> <a href =" ./src/contextual/types/agent_metadata.py " >AgentMetadata</a ></code >
152+ - <code title =" get /agents/templates " >client.agents.templates.<a href =" ./src/contextual/resources/agents/templates.py " >list</a >() -> <a href =" ./src/contextual/types/agents/template_list_response.py " >TemplateListResponse</a ></code >
153+
110154# Users
111155
112156Types:
0 commit comments