QueryBody

pydantic model openapi_client.models.query_body.QueryBody

Body for POST /ai/knowledgebases/{id}/query (unstructured knowledge bases only). modelId is required and must be a TEXT model assigned to knowledge bases. prompt defaults to empty string if omitted. Extra fields are ignored.

Fields:
field prompt: Optional[StrictStr] = None

User question. Optional. Defaults to empty string if omitted.

field model_id: Optional[StrictStr] = None (alias 'modelId')

TEXT model ID assigned for knowledge bases. Required. Not in the assigned list is rejected.

to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of QueryBody from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of QueryBody from a dict

Return type:

Optional[Self]