Pinecone · Schema

ChatModel

Describes the response format of a chat request from the citation API.

Vector DatabasesAIEmbeddingsRAG

Properties

Name	Type	Description
id	string
finish_reason	string
message	object
model	string
citations	array
usage	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ChatModel",
  "title": "ChatModel",
  "description": "Describes the response format of a chat request from the citation API.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "finish_reason": {
      "x-enum": [
        "stop",
        "length",
        "content_filter",
        "function_call"
      ],
      "type": "string"
    },
    "message": {
      "$ref": "#/components/schemas/MessageModel"
    },
    "model": {
      "type": "string"
    },
    "citations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CitationModel"
      }
    },
    "usage": {
      "$ref": "#/components/schemas/UsageModel"
    }
  }
}