Creates a Document or Text Source
Creates a Document or Text Source that can be added to Knowledge Bases as a Knowledge Base Source or used as context for an Explanation. Upload a file that can be used across various endpoints. Individual document files can be up to 100 MB, text Sources can be up to 1000000 characters long, and the size of all Sources uploaded by one Organization
can be up to 100 GB Document Sources
are submitted as multipart/form-data and Text Sources
as application/json.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
A document file (not file name) to be uploaded to Sources
. Supported file types are .pdf, .jpg, and .png.
Title of the document.
512
A url to the document source that can be used by clients to link back to the original document.
512
From what time the Source
can be used by a Knowledge Base
or an Explanation
. If no valid_from
is set, the Source
is valid from the time it is added to Sources
.
Until when the Source
can be used by a Knowledge Base
or an Explanation
. If no valid_until
is set, the Source
is valid until it is removed from Sources
.
The unique identifier of the project this Source
should be assigned to. Sources
can only be used by resources with the same project_id
. If no project_id
is set, the Source
will be assigned to the default project.
28
Custom optional metadata for a Source
provided by a client. Up to 10 key-value pairs.
Response
The Source
object represents a document source (.pdf, .jpg, .png) or text source (plain-text) that has been uploaded to Totoy.
Unique identifier for the Source
.
29
Type for this source (document or text).
document
, text
Size of the document file or text, in bytes.
Date-time for when the Source
was created, in ISO 8601 format.
Date-time for when the Source
was last modified, in ISO 8601 format.
The unique identifier of the project this Source
is assigned to. Sources
can only be used by resources with the same project_id
.
28
Title of the document or text.
512
The file name of a Source
document.
255
An external url to the Source
that can be used by clients to link back to the original document or text (i.e. a web page containing that text).
512
From what time the Source
can be used by a Knowledge Base
or an Explanation
. If no valid_from
is set, the Source
is valid from the time it is added to Sources
.
Until when the Source
can be used by a Knowledge Base
or an Explanation
. If no valid_until
is set, the Source
is valid until it is removed from Sources
.
Custom optional metadata for a Source
provided by a client. Up to 10 key-value pairs.
List of Knowledge Base
identifiers where this Source
is used.
The parsing status of the Document Source. The status completed
indicates that the source is ready for use. The status parameter is only available for Document Sources.
in_progress
, completed
, failed
The number of pages of the Document Source. The pages parameter is only available for Document Sources.