Create Chat Message Response

post https://api.donovan.scale.com/v1/chat

This endpoint generates the chat message response and saves it to its specified thread, which is a collection of messages to and from our Large Language Models

Body Params

Attributes needed to create a chat message

text

string

required

Text of the chat message

model

string

Defaults to SCALE_LLAMA_2_13B_CHAT

Base model type that you would like to chat/query against for this thread. Note: if you pass in a model that is not allowed in your organization, this will fail.

workspace

string

required

Unique ID for the workspace that this thread belongs to.

thread

string

Unique ID for a new or existing thread that holds the chat messages. If not specified, a new thread will be created with this message being the first message in the thread.

datasets

array of strings

Unique IDs for the datasets that you would like to chat/query against. These datasets must be in the workspace that you specified, and these will serve as added context to the model responses. If no datasets are specified, the model will still respond, but the responses will not use any of your documents as sources.

datasets

Responses

Response body

object

string

required

Unique ID for the newly created message

thread

string

required

Unique ID for the thread that the message was created in

metadata

object

required

Metadata about the generated message

sentAt

date-time

required

Date that message was sent at

requestDurationMs

number

required

Duration of the message creation process in milliseconds

modelType

string

required

Defaults to SCALE_LLAMA_2_13B_CHAT

Base model type was used to generate this response.

OPENAI_GPT4 OPENAI_GPT3.5-TURBO OPENAI_GPT3 ANTHROPIC_CLAUDE SCALE_GPT4ALLJ SCALE_GPTJENZH MPT_7B_INSTRUCT COHERE_CHAT SCALE_MPT_7B_CHAT SCALE_FALCON_40B_INSTRUCT SCALE_VICUNA_13B SCALE_LLAMA_2_13B_CHAT SCALE_LLAMA_2_7B_CHAT CODE_LLAMA_2_13B_INSTRUCT SCALE_MIXTRAL_8X7B_INSTRUCT SCALE_MISTRAL_7B_INSTRUCT SCALE_GEMMA_7B_INSTRUCT GROQ_MIXTRAL_8X7B_INSTRUCT SCALE_LLAMA_3_8B_INSTRUCT SCALE_NONPACIFISM_LLAMA_2_13B_CHAT SCALE_NONPACIFISM_LLAMA_3_8B_INSTRUCT WIZARDCODER_LLAMA_2_13B_INSTRUCT SCALE_STYLE_LLAMA_2_13B_CHAT

text

string

required

Message content generated by Donovan

citations

array of objects

Defaults to

Citation snippets for any information linked to responses

citations

object

body

string

required

Text snippet of the citation

pageNumber

number

required

Page number of the document that this citation can be found on, if applicable

citationId

string

required

Unique ID for the citation that can be mapped back to the text snippet's span IDs

externalUrl

string

For external sources, such as Microsoft SharePoint, Google Drive etc., this is the URL pointer to the document

messageParts

array of objects

Defaults to

Message parts broken up by type of content that the model generates

messageParts

object

content

string

required

citations

array of objects

required

Defaults to

citations*

object

body

string

required

s3AttachmentUrl

string

required

pageNumber

number

required

citationId

string

required

documentId

string

required

displayName

string

required

externalUrl

string

cited

boolean

sourceNumber

number

sourceType

string

sql document

metadata

object

Has additional fields

type

string

required

text code file geo audio image video chart

Response body

object

string

required

Unique ID for the newly created message

thread

string

required

Unique ID for the thread that the message was created in

metadata

object

required

Metadata about the generated message

sentAt

date-time

required

Date that message was sent at

requestDurationMs

number

required

Duration of the message creation process in milliseconds

modelType

string

required

Defaults to SCALE_LLAMA_2_13B_CHAT

Base model type was used to generate this response.

text

string

required

Message content generated by Donovan

citations

array of objects

Defaults to

Citation snippets for any information linked to responses

citations

object

body

string

required

Text snippet of the citation

pageNumber

number

required

Page number of the document that this citation can be found on, if applicable

citationId

string

required

Unique ID for the citation that can be mapped back to the text snippet's span IDs

externalUrl

string

For external sources, such as Microsoft SharePoint, Google Drive etc., this is the URL pointer to the document

messageParts

array of objects

Defaults to

Message parts broken up by type of content that the model generates

messageParts

object

content

string

required

citations

array of objects

required

Defaults to

citations*

object

body

string

required

s3AttachmentUrl

string

required

pageNumber

number

required

citationId

string

required

documentId

string

required

displayName

string

required

externalUrl

string

cited

boolean

sourceNumber

number

sourceType

string

sql document

metadata

object

Has additional fields

type

string

required

text code file geo audio image video chart

400

Bad Request

401

Unauthorized Request

403

Forbidden Request

500

Internal Server Error

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.donovan.scale.com/v1/chat \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "model": "SCALE_LLAMA_2_13B_CHAT"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful chat message creation

201