Search and queries¶
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¶
- Capabilities (GET)
- Create (POST)
- List (GET)
- Get (GET)
- Items (GET)
- Result (GET)
- Cancel (POST)
- Reconcile (POST)
- Search (POST)
- Query (POST)
Capabilities¶
GET /api/v1/tenants/{tenant_id}/query-batch-capabilities
Contract operation: QueryBatchController.capabilities.
| SDK | Method |
|---|---|
| Python | query_batch_capabilities |
| TypeScript | queryBatches.capabilities |
| Java | client.queryBatches.capabilities |
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] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | QueryBatchCapabilities |
| 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.
Create¶
POST /api/v1/tenants/{tenant_id}/queries/batches
Contract operation: QueryBatchController.create.
| SDK | Method |
|---|---|
| Python | create_query_batch |
| TypeScript | queryBatches.create |
| Java | client.queryBatches.create |
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[QueryBatchCreate]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | QueryBatchCreate |
| Response schema | QueryBatchView |
| 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¶
Idempotency-Key (required; caller-supplied stable operation key)
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
List¶
GET /api/v1/tenants/{tenant_id}/queries/batches
Contract operation: QueryBatchController.list.
| SDK | Method |
|---|---|
| Python | query_batches |
| TypeScript | queryBatches.list |
| Java | client.queryBatches.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 |
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 | QueryBatchPage |
| 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}/queries/batches/{batch_id}
Contract operation: QueryBatchController.get.
| SDK | Method |
|---|---|
| Python | query_batch |
| TypeScript | queryBatches.get |
| Java | client.queryBatches.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 |
batch_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | QueryBatchView |
| 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.
Items¶
GET /api/v1/tenants/{tenant_id}/queries/batches/{batch_id}/items
Contract operation: QueryBatchController.items.
| SDK | Method |
|---|---|
| Python | query_batch_items |
| TypeScript | queryBatches.items |
| Java | client.queryBatches.items |
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 |
batch_id |
path | PathVar[str] |
Yes | Not specified |
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 | QueryBatchItemPage |
| 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.
Result¶
GET /api/v1/tenants/{tenant_id}/queries/batches/{batch_id}/items/{item_id}/result
Contract operation: QueryBatchController.result.
| SDK | Method |
|---|---|
| Python | query_batch_result |
| TypeScript | queryBatches.result |
| Java | client.queryBatches.result |
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 |
batch_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 | QueryBatchResult |
| 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.
Cancel¶
POST /api/v1/tenants/{tenant_id}/queries/batches/{batch_id}/cancel
Contract operation: QueryBatchController.cancel.
| SDK | Method |
|---|---|
| Python | cancel_query_batch |
| TypeScript | queryBatches.cancel |
| Java | client.queryBatches.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 |
batch_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[QueryBatchAction]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | QueryBatchAction |
| Response schema | QueryBatchCancellation |
| 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¶
Idempotency-Key (required; caller-supplied stable operation key)
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Reconcile¶
POST /api/v1/tenants/{tenant_id}/queries/batches/{batch_id}/items/{item_id}/reconcile
Contract operation: QueryBatchController.reconcile.
| SDK | Method |
|---|---|
| Python | reconcile_query_batch_item |
| TypeScript | queryBatches.reconcile |
| Java | client.queryBatches.reconcile |
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 |
batch_id |
path | PathVar[str] |
Yes | Not specified |
item_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[QueryBatchAction]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | QueryBatchAction |
| Response schema | QueryBatchView |
| 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¶
Idempotency-Key (required; caller-supplied stable operation key)
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Search¶
POST /api/v1/tenants/{tenant_id}/search
Contract operation: KnowledgeController.search.
| SDK | Method |
|---|---|
| Python | search |
| TypeScript | search |
| Java | client.knowledge.search |
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[SearchInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | SearchRequest |
| Response schema | SearchResponse |
| 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.
Query¶
POST /api/v1/tenants/{tenant_id}/query
Contract operation: KnowledgeController.query.
| SDK | Method |
|---|---|
| Python | query |
| TypeScript | query |
| Java | client.knowledge.query |
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[QueryInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | QueryRequest |
| Response schema | QueryResponse |
| 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.