The Document Assistant API enables developers to integrate document-based assistant functionalities into their applications using AODocs.
The first step is to enable AIDA (AODocs Intelligent Document Assistant) in your tenant. The support team will provide you with the necessary information on how to get started.
The second step is to enable AIDA on libraries. You need to be an administrator of the
library to do this.
AIDA can answer questions only from those documents that are in an AIDA enabled
library.
We create a vector store index for these documents. This can take some time. The get
library API provides the status of the indexation and an estimate of the time
remaining.
The content of the index is automatically kept up-to-date near real time with the
content changes.
The third step is to ask questions based on the AODocs documents.
AIDA automatically filters the results based on the user's permissions.
Authentication: All API endpoints require a valid OAuth2 token in the Authorization header. Ensure the client ID of the OAuth2 token is whitelisted in AODocs.
version: 1.1.0 servers: - url: https://document-assistant.us.aodocs.app description: Production US - url: https://document-assistant.eu.aodocs.app description: Production EU security: [] paths: /assistant/api/v1/tenants/{tenant}/conversations/{conversation_id}/messages: get: tags: - chat summary: Get Messages in Conversation operationId: >- list_conversation_messages_assistant_api_v1_tenants__tenant__conversations__conversation_id__messages_get parameters: - name: conversation_id in: path required: true schema: type: string description: The conversation id title: Conversation Id description: The conversation id - name: tenant in: path required: true schema: anyOf: - type: string - type: 'null' description: The domain of the customer examples: - example.com title: Tenant description: The domain of the customer - name: size in: query required: false schema: anyOf: - type: integer - type: 'null' title: Size - name: pageToken in: query required: false schema: anyOf: - type: string - type: 'null' title: Pagetoken responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetMessagesDto' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: GetMessagesDto: properties: messages: items: $ref: '#/components/schemas/MessageDto' type: array title: Messages nextPageToken: anyOf: - type: string - type: 'null' title: Nextpagetoken type: object required: - messages - nextPageToken title: GetMessagesDto HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError MessageDto: properties: message_id: type: string title: Message Id timestamp: type: string title: Timestamp message: type: string title: Message responses: items: $ref: '#/components/schemas/ResponseDto' type: array title: Responses type: object required: - message_id - timestamp - message - responses title: MessageDto ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError ResponseDto: properties: response_id: anyOf: - type: string - type: 'null' title: Response Id message: anyOf: - type: string - type: 'null' title: Message feedback: anyOf: - $ref: '#/components/schemas/FeedbackDto' - type: 'null' sources: anyOf: - items: $ref: '#/components/schemas/Reference' type: array - type: 'null' title: Sources links: anyOf: - items: $ref: '#/components/schemas/LinkDto' type: array - type: 'null' title: Links type: object required: - response_id - message - feedback - sources - links title: ResponseDto FeedbackDto: properties: type: $ref: '#/components/schemas/FeedbackType' text: anyOf: - type: string - type: 'null' title: Text rating: anyOf: - type: integer - type: 'null' title: Rating categories: items: $ref: '#/components/schemas/FeedbackCategory' type: array title: Categories default: [] type: object required: - type title: FeedbackDto Reference: properties: id: type: string title: Id description: Unique identifier for the reference library_id: type: string title: Library Id description: The library ID of the node document_id: type: string title: Document Id description: The document ID of the node document_title: type: string title: Document Title description: Title of document document_link: type: string title: Document Link description: Link to the document quoted_text: anyOf: - type: string - type: 'null' title: Quoted Text description: >- Quoted text from the document. A short excerpt that verifies verbatim against the source where the answering flow narrowed it — the default for content-search answers — and the full retrieved source chunk otherwise. quote_narrowed tells the two apart; set use_supporting_quotes to false to always keep the full chunk. attachment_id: anyOf: - type: string - type: 'null' title: Attachment Id description: The attachment ID of the node attachment_name: anyOf: - type: string - type: 'null' title: Attachment Name description: The attachment name of the node attachment_mime_type: anyOf: - type: string - type: 'null' title: Attachment Mime Type description: The attachment mime type of the node attachment_link: anyOf: - type: string - type: 'null' title: Attachment Link description: The attachment link of the node location_info: anyOf: - type: string - type: 'null' title: Location Info description: Location of the quoted text on the document (optional location_type: anyOf: - type: string - type: 'null' title: Location Type description: Type of the location of the quoted text revision_id: anyOf: - type: string - type: 'null' title: Revision Id description: The revision ID of the attachment (optional) external_source_url: anyOf: - type: string - type: 'null' title: External Source Url description: URL of the external source external_source_title: anyOf: - type: string - type: 'null' title: External Source Title description: Display name of the external source quote_narrowed: type: boolean title: Quote Narrowed description: >- True when quoted_text has already been narrowed to a short, verified supporting quote (or nulled after failing verification) instead of holding the full raw retrieved chunk. Set only where that narrowing actually happens; callers deciding whether to strip quoted_text should check this field rather than the request's feature flags, since a flag being on doesn't mean the citation's own flow acted on it. default: false bounding_boxes_available: type: boolean title: Bounding Boxes Available description: >- Whether this citation can be submitted to the bounding-box lookup endpoint. readOnly: true type: object required: - id - library_id - document_id - document_title - document_link - bounding_boxes_available title: Reference LinkDto: properties: title: type: string title: Title url: type: string title: Url type: object required: - title - url title: LinkDto FeedbackType: type: string enum: - Like - Dislike - Cancel title: FeedbackType FeedbackCategory: type: string enum: - answer_incorrect - sources_wrong - sources_missing - answer_incomplete - too_slow - format_unclear - other title: FeedbackCategory securitySchemes: HTTPBearer: type: http scheme: bearer ````