Curated knowledge¶
Use the linked wire models for field constraints. Operation metadata does not enumerate every possible HTTP error or replace current server authorization.
On this page¶
Preview¶
POST /api/v1/tenants/{tenant_id}/knowledge-intents
Contract operation: CuratedKnowledgeController.preview.
| SDK | Method |
|---|---|
| Python | preview_knowledge |
| TypeScript | knowledgeIntents.preview |
| Java | client.knowledgeIntents.preview |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[KnowledgeIntentInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | KnowledgeIntentInput |
| Response schema | KnowledgeIntent |
| Success status | 201 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Intent¶
GET /api/v1/tenants/{tenant_id}/knowledge-intents/{intent_id}
Contract operation: CuratedKnowledgeController.intent.
| SDK | Method |
|---|---|
| Python | knowledge_intent |
| TypeScript | knowledgeIntents.get |
| Java | client.knowledgeIntents.get |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
intent_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | KnowledgeIntent |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Confirm¶
POST /api/v1/tenants/{tenant_id}/knowledge-intents/{intent_id}/confirm
Contract operation: CuratedKnowledgeController.confirm.
| SDK | Method |
|---|---|
| Python | confirm_knowledge |
| TypeScript | knowledgeIntents.confirm |
| Java | client.knowledgeIntents.confirm |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
intent_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[KnowledgeConfirmation]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | KnowledgeConfirmation |
| Response schema | KnowledgeCommitOutcome |
| Success status | 200, 202 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
Idempotency-Key (required; caller-supplied stable operation key)
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Cancel¶
POST /api/v1/tenants/{tenant_id}/knowledge-intents/{intent_id}/cancel
Contract operation: CuratedKnowledgeController.cancel.
| SDK | Method |
|---|---|
| Python | cancel_knowledge |
| TypeScript | knowledgeIntents.cancel |
| Java | client.knowledgeIntents.cancel |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
intent_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[KnowledgeCancellation]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | KnowledgeCancellation |
| Response schema | KnowledgeIntent |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
List¶
GET /api/v1/tenants/{tenant_id}/knowledge-items
Contract operation: CuratedKnowledgeController.list.
| SDK | Method |
|---|---|
| Python | knowledge_items |
| TypeScript | knowledgeItems.list |
| Java | client.knowledgeItems.list |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
workspace_id |
query | QueryParam[str | None] |
No | null |
project_id |
query | QueryParam[str | None] |
No | null |
destination_id |
query | QueryParam[str | None] |
No | null |
q |
query | QueryParam[str] |
No | "" |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | KnowledgeItemPage |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Get¶
GET /api/v1/tenants/{tenant_id}/knowledge-items/{item_id}
Contract operation: CuratedKnowledgeController.get.
| SDK | Method |
|---|---|
| Python | knowledge_item |
| TypeScript | knowledgeItems.get |
| Java | client.knowledgeItems.get |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
item_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | KnowledgeItemView |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Version¶
GET /api/v1/tenants/{tenant_id}/knowledge-items/{item_id}/versions/{version}
Contract operation: CuratedKnowledgeController.version.
| SDK | Method |
|---|---|
| Python | knowledge_version |
| TypeScript | knowledgeItems.version |
| Java | client.knowledgeItems.version |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
item_id |
path | PathVar[str] |
Yes | Not specified |
version |
path | PathVar[int] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | KnowledgeItemView |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.