Sign in

Create knowledge

Create knowledge

post/v1/Knowledge

Request body

assistant_idstring

The Assistant ID.

descriptionstring

The description of the knowledge source.

knowledge_source_detailsobject

The details of the knowledge source based on the type.

namestring required

The name of the tool.

typestring required

The type of the knowledge source.

embedding_modelstring

The embedding model to be used for the knowledge source. It's required for 'Database' type but disallowed for other types.

Response

Created

descriptionstring

The type of knowledge source.

idstring required

The description of knowledge.

account_sidstring

The SID of the Account that created the Knowledge resource.

knowledge_source_detailsobject

The details of the knowledge source based on the type.

namestring required

The name of the knowledge source.

statusstring

The status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED')

typestring required

The type of knowledge source ('Web', 'Database', 'Text', 'File')

urlstring

The url of the knowledge resource.

embedding_modelstring

The embedding model to be used for the knowledge source.

date_createdstring date-time required

The date and time in GMT when the Knowledge was created specified in ISO 8601 format.

date_updatedstring date-time required

The date and time in GMT when the Knowledge was last updated specified in ISO 8601 format.

Changes

Changed in 3 of the 10 revisions of this API.29

  • v10852198458a021See the full diff
    • ●

      changed the pattern of the request property assistant_id from ^aia_asst_*$ to ^aia_asst_.+$

      request-property-pattern-changed

    • ●

      changed the pattern of the request property policy/id from ^aia_plcy_*$ to ^aia_plcy_.+$

      request-property-pattern-changed

    • ○

      the id response's property pattern was changed from ^aia_know_*$ to ^aia_know_.+$ for the status 201

      response-property-pattern-changed

  • v182c51662c2667See the full diff
    • ○

      added the new optional request property embedding_model

      new-optional-request-property

    • ○

      added the optional property embedding_model to the response with the 201 status

      response-optional-property-added

    • ○

      the response property date_created became required for the status 201

      response-property-became-required

    • ○

      the response property date_updated became required for the status 201

      response-property-became-required

    • ○

      the response property id became required for the status 201

      response-property-became-required

    • ○

      the response property name became required for the status 201

      response-property-became-required

    • ○

      the response property type became required for the status 201

      response-property-became-required

  • v11ad87f675d4b1See the full diff
    • ○

      added the optional property url to the response with the 201 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog