@julep/sdk / Modules / api
Module: api
Table of contents
References
Classes
Type Aliases
Variables
References
JulepApiClient
Re-exports JulepApiClient
Type Aliases
Agent
Ζ¬ Agent: Object
Type declaration
| Name | Type | Description |
|---|
| | |
| | Agent created at (RFC-3339 format) |
| | Default settings for all sessions created by this agent |
| | |
| | Instructions for the agent |
| | |
| | The model to use with this agent |
| | |
| | Agent updated at (RFC-3339 format) |
Defined in
src/api/models/Agent.ts:6
AgentDefaultSettings
Ζ¬ AgentDefaultSettings: Object
Type declaration
| Name | Type | Description |
|---|
| | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. |
| | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. |
| | Minimum probability compared to leading token to be considered |
| | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. |
| "problem_solving" | "conversational" | "fun" | "prose" | "creative" | "business" | "deterministic" | "code" | "multilingual"
| Generation preset name (one of: problem_solving, conversational, fun, prose, creative, business, deterministic, code, multilingual) |
| | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. |
| | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. |
| | Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. |
Defined in
src/api/models/AgentDefaultSettings.ts:5
ChatInput
Ζ¬ ChatInput: ChatInputData & ChatSettings & MemoryAccessOptions
Defined in
src/api/models/ChatInput.ts:8
ChatInputData
Ζ¬ ChatInputData: Object
Type declaration
| Name | Type | Description |
|---|
| | A list of new input messages comprising the conversation so far. |
| | Can be one of existing tools given to the agent earlier or the ones included in the request |
| | (Advanced) List of tools that are provided in addition to agent's default set of tools. Functions of same name in agent set are overriden |
Defined in
src/api/models/ChatInputData.ts:9
ChatMLImageContentPart
Ζ¬ ChatMLImageContentPart: Object
Type declaration
| Name | Type | Description |
|---|
| { detail?: "low" | "high" | "auto" ; url: string } | Image content part, can be a URL or a base64-encoded image |
| | image detail to feed into the model can be low | high | auto |
| | URL or base64 data url (e.g. data:image/jpeg;base64,<the base64 encoded image>) |
| | |
Defined in
src/api/models/ChatMLImageContentPart.ts:5
ChatMLMessage
Ζ¬ ChatMLMessage: Object
Type declaration
| Name | Type | Description |
|---|
| | |
| | Message created at (RFC-3339 format) |
| | |
| | |
| "user" | "assistant" | "system" | "function_call" | "function"
| ChatML role (system|assistant|user|function_call|function) |
Defined in
src/api/models/ChatMLMessage.ts:5
ChatMLTextContentPart
Ζ¬ ChatMLTextContentPart: Object
Type declaration
Defined in
src/api/models/ChatMLTextContentPart.ts:5
ChatResponse
Ζ¬ ChatResponse: Object
Represents a chat completion response returned by model, based on the provided input.
Type declaration
| Name | Type | Description |
|---|
| | |
| "stop" | "length" | "tool_calls" | "content_filter" | "function_call"
| The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, content_filter if content was omitted due to a flag from our content filters, tool_calls if the model called a tool, or function_call (deprecated) if the model called a function. |
| | A unique identifier for the chat completion. |
| | IDs (if any) of jobs created as part of this request |
| | A list of chat completion messages produced as a response. |
| | |
Defined in
src/api/models/ChatResponse.ts:11
ChatSettings
Ζ¬ ChatSettings: Object
Type declaration
| Name | Type | Description |
|---|
| | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. |
| | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. |
| Record<string, number> | null
| Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. |
| | The maximum number of tokens to generate in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. |
| | Minimum probability compared to leading token to be considered |
| | (OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. |
| "problem_solving" | "conversational" | "fun" | "prose" | "creative" | "business" | "deterministic" | "code" | "multilingual"
| Generation preset name (problem_solving|conversational|fun|prose|creative|business|deterministic|code|multilingual) |
| | (Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. |
| { pattern?: string ; schema?: any ; type?: "text" | "json_object" | "regex" } | An object specifying the format that the model must output. Setting to { "type": "json_object" } enables JSON mode, which guarantees the message the model generates is valid JSON. Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length. |
| | Regular expression pattern to use if type is "regex" |
| | JSON Schema to use if type is "json_object" |
| "text" | "json_object" | "regex"
| Must be one of "text", "regex" or "json_object". |
| | This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend. |
| | Up to 4 sequences where the API will stop generating further tokens. |
| | If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Example Python code. |
| | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. |
| | Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. |
Defined in
src/api/models/ChatSettings.ts:5
CompletionUsage
Ζ¬ CompletionUsage: Object
Usage statistics for the completion request.
Type declaration
| Name | Type | Description |
|---|
| | Number of tokens in the generated completion. |
| | Number of tokens in the prompt. |
| | Total number of tokens used in the request (prompt + completion). |
Defined in
src/api/models/CompletionUsage.ts:8
CreateAgentRequest
Ζ¬ CreateAgentRequest: Object
A valid request payload for creating an agent
Type declaration
| Name | Type | Description |
|---|
| | |
| | Default model settings to start every session with |
| | |
| | Instructions for the agent |
| | |
| | Name of the model that the agent is supposed to use |
| | |
| | A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. |
Defined in
src/api/models/CreateAgentRequest.ts:11
CreateDoc
Ζ¬ CreateDoc: Object
Type declaration
| Name | Type | Description |
|---|
| | |
| | |
| | Title describing what this bit of information contains |
Defined in
src/api/models/CreateDoc.ts:5
CreateSessionRequest
Ζ¬ CreateSessionRequest: Object
A valid request payload for creating a session
Type declaration
| Name | Type | Description |
|---|
| | Agent ID of agent to associate with this session |
| | Action to start on context window overflow |
| | |
| | Render system and assistant message content as jinja templates |
| | A specific situation that sets the background for this session |
| | Threshold value for the adaptive context functionality |
| | (Optional) User ID of user to associate with this session |
Defined in
src/api/models/CreateSessionRequest.ts:8
CreateToolRequest
Ζ¬ CreateToolRequest: Object
Type declaration
| Name | Type | Description |
|---|
| | Function definition and parameters |
| | Whether this tool is a function or a webhook (Only function tool supported right now) |
Defined in
src/api/models/CreateToolRequest.ts:6
CreateUserRequest
Ζ¬ CreateUserRequest: Object
A valid request payload for creating a user
Type declaration
Defined in
src/api/models/CreateUserRequest.ts:9
Doc
Ζ¬ Doc: Object
Type declaration
| Name | Type | Description |
|---|
| | |
| | |
| | |
| | |
| | Title describing what this bit of information contains |
Defined in
src/api/models/Doc.ts:5
DocIds
Ζ¬ DocIds: Object
Type declaration
Defined in
src/api/models/DocIds.ts:5
FunctionCallOption
Ζ¬ FunctionCallOption: Object
Specifying a particular function via {"name": "my_function"} forces the model to call that function.
Type declaration
| Name | Type | Description |
|---|
| | The name of the function to call. |
Defined in
src/api/models/FunctionCallOption.ts:9
FunctionDef
Ζ¬ FunctionDef: Object
Type declaration
| Name | Type | Description |
|---|
| | A description of what the function does, used by the model to choose when and how to call the function. |
| | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. |
| | Parameters accepeted by this function |
Defined in
src/api/models/FunctionDef.ts:6
FunctionParameters
Ζ¬ FunctionParameters: Record<string, any>
The parameters the functions accepts, described as a JSON Schema object.
Defined in
src/api/models/FunctionParameters.ts:8
InputChatMLMessage
Ζ¬ InputChatMLMessage: Object
Type declaration
| Name | Type | Description |
|---|
| | |
| | Whether to continue this message or return a new one |
| | |
| "user" | "assistant" | "system" | "function_call" | "function" | "auto"
| ChatML role (system|assistant|user|function_call|function|auto) |
Defined in
src/api/models/InputChatMLMessage.ts:5
JobStatus
Ζ¬ JobStatus: Object
Type declaration
| Name | Type | Description |
|---|
| | Job created at (RFC-3339 format) |
| | Whether this Job supports progress updates |
| | |
| | |
| | |
| | |
| "pending" | "in_progress" | "retrying" | "succeeded" | "aborted" | "failed" | "unknown"
| Current state (one of: pending, in_progress, retrying, succeeded, aborted, failed) |
| | Job updated at (RFC-3339 format) |
Defined in
src/api/models/JobStatus.ts:5
Memory
Ζ¬ Memory: Object
Type declaration
| Name | Type | Description |
|---|
| | |
| | |
| | Memory created at (RFC-3339 format) |
| | List of entities mentioned in the memory |
| | |
| | Memory last accessed at (RFC-3339 format) |
| | Sentiment (valence) of the memory on a scale of -1 to 1 |
| | Memory happened at (RFC-3339 format) |
| | |
Defined in
src/api/models/Memory.ts:5
MemoryAccessOptions
Ζ¬ MemoryAccessOptions: Object
Type declaration
| Name | Type | Description |
|---|
| | Whether previous memories should be recalled or not |
| | Whether this interaction should be recorded in history or not |
| | Whether this interaction should form memories or not |
Defined in
src/api/models/MemoryAccessOptions.ts:5
NamedToolChoice
Ζ¬ NamedToolChoice: Object
Specifies a tool the model should use. Use to force the model to call a specific function.
Type declaration
| Name | Type | Description |
|---|
| | |
| | The name of the function to call. |
| | The type of the tool. Currently, only function is supported. |
Defined in
src/api/models/NamedToolChoice.ts:8
OpenAPIConfig
Ζ¬ OpenAPIConfig: Object
Type declaration
| Name | Type |
|---|
| |
| "include" | "omit" | "same-origin"
|
| |
| Headers | Resolver<Headers>
|
| string | Resolver<string>
|
| string | Resolver<string>
|
| string | Resolver<string>
|
| |
| |
Defined in
src/api/core/OpenAPI.ts:10
PartialFunctionDef
Ζ¬ PartialFunctionDef: Object
Type declaration
| Name | Type | Description |
|---|
| | A description of what the function does, used by the model to choose when and how to call the function. |
| | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. |
| | Parameters accepeted by this function |
Defined in
src/api/models/PartialFunctionDef.ts:6
PatchAgentRequest
Ζ¬ PatchAgentRequest: Object
A request for patching an agent
Type declaration
| Name | Type | Description |
|---|
| | |
| | Default model settings to start every session with |
| | Instructions for the agent |
| | |
| | Name of the model that the agent is supposed to use |
| | |
Defined in
src/api/models/PatchAgentRequest.ts:9
PatchSessionRequest
Ζ¬ PatchSessionRequest: Object
A request for patching a session
Type declaration
| Name | Type | Description |
|---|
| | Action to start on context window overflow |
| | |
| | Updated situation for this session |
| | Threshold value for the adaptive context functionality |
Defined in
src/api/models/PatchSessionRequest.ts:8
PatchToolRequest
Ζ¬ PatchToolRequest: Object
Type declaration
| Name | Type | Description |
|---|
| | Function definition and parameters |
Defined in
src/api/models/PatchToolRequest.ts:6
PatchUserRequest
Ζ¬ PatchUserRequest: Object
A request for patching a user
Type declaration
Defined in
src/api/models/PatchUserRequest.ts:8
ResourceCreatedResponse
Ζ¬ ResourceCreatedResponse: Object
Type declaration
| Name | Type | Description |
|---|
| | |
| | |
| | IDs (if any) of jobs created as part of this request |
Defined in
src/api/models/ResourceCreatedResponse.ts:5
ResourceDeletedResponse
Ζ¬ ResourceDeletedResponse: Object
Type declaration
| Name | Type | Description |
|---|
| | |
| | |
| | IDs (if any) of jobs created as part of this request |
Defined in
src/api/models/ResourceDeletedResponse.ts:5
ResourceUpdatedResponse
Ζ¬ ResourceUpdatedResponse: Object
Type declaration
| Name | Type | Description |
|---|
| | |
| | IDs (if any) of jobs created as part of this request |
| | |
Defined in
src/api/models/ResourceUpdatedResponse.ts:5
Session
Ζ¬ Session: Object
Type declaration
| Name | Type | Description |
|---|
| | Agent ID of agent associated with this session |
| | Action to start on context window overflow |
| | Session created at (RFC-3339 format) |
| | |
| | |
| | Render system and assistant message content as jinja templates |
| | A specific situation that sets the background for this session |
| | (null at the beginning) - generated automatically after every interaction |
| | Threshold value for the adaptive context functionality |
| | Session updated at (RFC-3339 format) |
| | User ID of user associated with this session |
Defined in
src/api/models/Session.ts:5
Suggestion
Ζ¬ Suggestion: Object
Type declaration
| Name | Type | Description |
|---|
| | The content of the suggestion |
| | Suggestion created at (RFC-3339 format) |
| | The message that produced it |
| | Session this suggestion belongs to |
| | Whether the suggestion is for the agent or a user |
Defined in
src/api/models/Suggestion.ts:5
Tool
Ζ¬ Tool: Object
Type declaration
| Name | Type | Description |
|---|
| | Function definition and parameters |
| | |
| | Whether this tool is a function or a webhook (Only function tool supported right now) |
Defined in
src/api/models/Tool.ts:6
ToolChoiceOption
Ζ¬ ToolChoiceOption: "none" | "auto" | NamedToolChoice
Controls which (if any) function is called by the model. none means the model will not call a function and instead generates a message. auto means the model can pick between generating a message or calling a function. Specifying a particular function via {"type: "function", "function": {"name": "my_function"}} forces the model to call that function.
none is the default when no functions are present. auto is the default if functions are present.
Defined in
src/api/models/ToolChoiceOption.ts:15
UpdateAgentRequest
Ζ¬ UpdateAgentRequest: Object
A valid request payload for updating an agent
Type declaration
| Name | Type | Description |
|---|
| | |
| | Default model settings to start every session with |
| | Instructions for the agent |
| | |
| | Name of the model that the agent is supposed to use |
| | |
Defined in
src/api/models/UpdateAgentRequest.ts:9
UpdateSessionRequest
Ζ¬ UpdateSessionRequest: Object
A valid request payload for updating a session
Type declaration
| Name | Type | Description |
|---|
| | Action to start on context window overflow |
| | |
| | Updated situation for this session |
| | Threshold value for the adaptive context functionality |
Defined in
src/api/models/UpdateSessionRequest.ts:8
UpdateToolRequest
Ζ¬ UpdateToolRequest: Object
Type declaration
| Name | Type | Description |
|---|
| | Function definition and parameters |
Defined in
src/api/models/UpdateToolRequest.ts:6
UpdateUserRequest
Ζ¬ UpdateUserRequest: Object
A valid request payload for updating a user
Type declaration
Defined in
src/api/models/UpdateUserRequest.ts:8
User
Ζ¬ User: Object
Type declaration
| Name | Type | Description |
|---|
| | |
| | User created at (RFC-3339 format) |
| | |
| | |
| | |
| | User updated at (RFC-3339 format) |
Defined in
src/api/models/User.ts:5
agent_id
Ζ¬ agent_id: string
Defined in
src/api/models/agent_id.ts:5
doc_id
Ζ¬ doc_id: string
Defined in
src/api/models/doc_id.ts:5
job_id
Ζ¬ job_id: string
Defined in
src/api/models/job_id.ts:5
memory_id
Ζ¬ memory_id: string
Defined in
src/api/models/memory_id.ts:5
message_id
Ζ¬ message_id: string
Defined in
src/api/models/message_id.ts:5
session_id
Ζ¬ session_id: string
Defined in
src/api/models/session_id.ts:5
tool_id
Ζ¬ tool_id: string
Defined in
src/api/models/tool_id.ts:5
user_id
Ζ¬ user_id: string
Defined in
src/api/models/user_id.ts:5
Variables
$Agent
β’ Const $Agent: Object
Type declaration
| Name | Type |
|---|
| { about: { description: "About the agent" ; type: "string" = "string" } ; created_at: { description: "Agent created at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } ; default_settings: { description: "Default settings for all sessions created by this agent" ; type: "AgentDefaultSettings" = "AgentDefaultSettings" } ; id: { description: "Agent id (UUID)" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; instructions: { contains: readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] ; description: "Instructions for the agent" ; type: "one-of" = "one-of" } ; metadata: { description: "Optional metadata" ; properties: {} = {} } ; model: { description: "The model to use with this agent" ; isRequired: true = true; type: "string" = "string" } ; name: { description: "Name of the agent" ; isRequired: true = true; type: "string" = "string" } ; updated_at: { description: "Agent updated at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } } |
| { description: "About the agent" ; type: "string" = "string" } |
properties.about.description
| |
| |
| { description: "Agent created at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } |
properties.created_at.description
| "Agent created at (RFC-3339 format)"
|
properties.created_at.format
| |
properties.created_at.type
| |
properties.default_settings
| { description: "Default settings for all sessions created by this agent" ; type: "AgentDefaultSettings" = "AgentDefaultSettings" } |
properties.default_settings.description
| "Default settings for all sessions created by this agent"
|
properties.default_settings.type
| |
| { description: "Agent id (UUID)" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.id.description
| |
| |
| |
| |
| { contains: readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] ; description: "Instructions for the agent" ; type: "one-of" = "one-of" } |
properties.instructions.contains
| readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] |
properties.instructions.description
| "Instructions for the agent"
|
properties.instructions.type
| |
| { description: "Optional metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "The model to use with this agent" ; isRequired: true = true; type: "string" = "string" } |
properties.model.description
| "The model to use with this agent"
|
properties.model.isRequired
| |
| |
| { description: "Name of the agent" ; isRequired: true = true; type: "string" = "string" } |
properties.name.description
| |
properties.name.isRequired
| |
| |
| { description: "Agent updated at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } |
properties.updated_at.description
| "Agent updated at (RFC-3339 format)"
|
properties.updated_at.format
| |
properties.updated_at.type
| |
Defined in
src/api/schemas/$Agent.ts:5
$AgentDefaultSettings
β’ Const $AgentDefaultSettings: Object
Type declaration
| Name | Type |
|---|
| { frequency_penalty: { description: "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 2 = 2; minimum: -2 = -2; type: "number" = "number" } ; length_penalty: { description: "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. " ; isNullable: true = true; maximum: 2 = 2; type: "number" = "number" } ; min_p: { description: "Minimum probability compared to leading token to be considered" ; exclusiveMaximum: true = true; maximum: 1 = 1; type: "number" = "number" } ; presence_penalty: { description: "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 1 = 1; minimum: -1 = -1; type: "number" = "number" } ; preset: { type: "Enum" = "Enum" } ; repetition_penalty: { description: "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 2 = 2; type: "number" = "number" } ; temperature: { description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." ; isNullable: true = true; maximum: 3 = 3; type: "number" = "number" } ; top_p: { description: "Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both." ; isNullable: true = true; maximum: 1 = 1; type: "number" = "number" } } |
properties.frequency_penalty
| { description: "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 2 = 2; minimum: -2 = -2; type: "number" = "number" } |
properties.frequency_penalty.description
| "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."
|
properties.frequency_penalty.isNullable
| |
properties.frequency_penalty.maximum
| |
properties.frequency_penalty.minimum
| |
properties.frequency_penalty.type
| |
properties.length_penalty
| { description: "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. " ; isNullable: true = true; maximum: 2 = 2; type: "number" = "number" } |
properties.length_penalty.description
| "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "
|
properties.length_penalty.isNullable
| |
properties.length_penalty.maximum
| |
properties.length_penalty.type
| |
| { description: "Minimum probability compared to leading token to be considered" ; exclusiveMaximum: true = true; maximum: 1 = 1; type: "number" = "number" } |
properties.min_p.description
| "Minimum probability compared to leading token to be considered"
|
properties.min_p.exclusiveMaximum
| |
| |
| |
properties.presence_penalty
| { description: "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 1 = 1; minimum: -1 = -1; type: "number" = "number" } |
properties.presence_penalty.description
| "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."
|
properties.presence_penalty.isNullable
| |
properties.presence_penalty.maximum
| |
properties.presence_penalty.minimum
| |
properties.presence_penalty.type
| |
| { type: "Enum" = "Enum" } |
| |
properties.repetition_penalty
| { description: "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 2 = 2; type: "number" = "number" } |
properties.repetition_penalty.description
| "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."
|
properties.repetition_penalty.isNullable
| |
properties.repetition_penalty.maximum
| |
properties.repetition_penalty.type
| |
| { description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." ; isNullable: true = true; maximum: 3 = 3; type: "number" = "number" } |
properties.temperature.description
| "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."
|
properties.temperature.isNullable
| |
properties.temperature.maximum
| |
properties.temperature.type
| |
| { description: "Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both." ; isNullable: true = true; maximum: 1 = 1; type: "number" = "number" } |
properties.top_p.description
| "Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."
|
properties.top_p.isNullable
| |
| |
| |
Defined in
src/api/schemas/$AgentDefaultSettings.ts:5
$ChatInput
β’ Const $ChatInput: Object
Type declaration
| Name | Type |
|---|
| readonly [{ type: "ChatInputData" = "ChatInputData" }, { type: "ChatSettings" = "ChatSettings" }, { type: "MemoryAccessOptions" = "MemoryAccessOptions" }] |
| |
Defined in
src/api/schemas/$ChatInput.ts:5
$ChatInputData
β’ Const $ChatInputData: Object
Type declaration
| Name | Type |
|---|
| { messages: { contains: { type: "InputChatMLMessage" = "InputChatMLMessage" } ; isRequired: true = true; type: "array" = "array" } ; tool_choice: { contains: readonly [{ type: "ToolChoiceOption" = "ToolChoiceOption" }, { type: "NamedToolChoice" = "NamedToolChoice" }] ; description: "Can be one of existing tools given to the agent earlier or the ones included in the request" ; isNullable: true = true; type: "one-of" = "one-of" } ; tools: { contains: { type: "Tool" = "Tool" } ; isNullable: true = true; type: "array" = "array" } } |
| { contains: { type: "InputChatMLMessage" = "InputChatMLMessage" } ; isRequired: true = true; type: "array" = "array" } |
properties.messages.contains
| { type: "InputChatMLMessage" = "InputChatMLMessage" } |
properties.messages.contains.type
| |
properties.messages.isRequired
| |
| |
| { contains: readonly [{ type: "ToolChoiceOption" = "ToolChoiceOption" }, { type: "NamedToolChoice" = "NamedToolChoice" }] ; description: "Can be one of existing tools given to the agent earlier or the ones included in the request" ; isNullable: true = true; type: "one-of" = "one-of" } |
properties.tool_choice.contains
| readonly [{ type: "ToolChoiceOption" = "ToolChoiceOption" }, { type: "NamedToolChoice" = "NamedToolChoice" }] |
properties.tool_choice.description
| "Can be one of existing tools given to the agent earlier or the ones included in the request"
|
properties.tool_choice.isNullable
| |
properties.tool_choice.type
| |
| { contains: { type: "Tool" = "Tool" } ; isNullable: true = true; type: "array" = "array" } |
properties.tools.contains
| { type: "Tool" = "Tool" } |
properties.tools.contains.type
| |
properties.tools.isNullable
| |
| |
Defined in
src/api/schemas/$ChatInputData.ts:5
$ChatMLImageContentPart
β’ Const $ChatMLImageContentPart: Object
Type declaration
| Name | Type |
|---|
| { image_url: { description: "Image content part, can be a URL or a base64-encoded image" ; isRequired: true = true; properties: { detail: { type: "Enum" = "Enum" } ; url: { description: "URL or base64 data url (e.g. `data:image/jpeg;base64,<the base64 encoded image>`)" ; isRequired: true = true; type: "string" = "string" } } } ; type: { isRequired: true = true; type: "Enum" = "Enum" } } |
| { description: "Image content part, can be a URL or a base64-encoded image" ; isRequired: true = true; properties: { detail: { type: "Enum" = "Enum" } ; url: { description: "URL or base64 data url (e.g. `data:image/jpeg;base64,<the base64 encoded image>`)" ; isRequired: true = true; type: "string" = "string" } } } |
properties.image_url.description
| "Image content part, can be a URL or a base64-encoded image"
|
properties.image_url.isRequired
| |
properties.image_url.properties
| { detail: { type: "Enum" = "Enum" } ; url: { description: "URL or base64 data url (e.g. `data:image/jpeg;base64,<the base64 encoded image>`)" ; isRequired: true = true; type: "string" = "string" } } |
properties.image_url.properties.detail
| { type: "Enum" = "Enum" } |
properties.image_url.properties.detail.type
| |
properties.image_url.properties.url
| { description: "URL or base64 data url (e.g. `data:image/jpeg;base64,<the base64 encoded image>`)" ; isRequired: true = true; type: "string" = "string" } |
properties.image_url.properties.url.description
| "URL or base64 data url (e.g. `data:image/jpeg;base64,<the base64 encoded image>`)"
|
properties.image_url.properties.url.isRequired
| |
properties.image_url.properties.url.type
| |
| { isRequired: true = true; type: "Enum" = "Enum" } |
properties.type.isRequired
| |
| |
Defined in
src/api/schemas/$ChatMLImageContentPart.ts:5
$ChatMLMessage
β’ Const $ChatMLMessage: Object
Type declaration
| Name | Type |
|---|
| { content: { contains: readonly [{ type: "string" = "string" }] ; description: "ChatML content" ; isRequired: true = true; type: "one-of" = "one-of" } ; created_at: { description: "Message created at (RFC-3339 format)" ; format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } ; id: { description: "Message ID" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; name: { description: "ChatML name" ; type: "string" = "string" } ; role: { isRequired: true = true; type: "Enum" = "Enum" } } |
| { contains: readonly [{ type: "string" = "string" }] ; description: "ChatML content" ; isRequired: true = true; type: "one-of" = "one-of" } |
properties.content.contains
| readonly [{ type: "string" = "string" }] |
properties.content.description
| |
properties.content.isRequired
| |
| |
| { description: "Message created at (RFC-3339 format)" ; format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } |
properties.created_at.description
| "Message created at (RFC-3339 format)"
|
properties.created_at.format
| |
properties.created_at.isRequired
| |
properties.created_at.type
| |
| { description: "Message ID" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.id.description
| |
| |
| |
| |
| { description: "ChatML name" ; type: "string" = "string" } |
properties.name.description
| |
| |
| { isRequired: true = true; type: "Enum" = "Enum" } |
properties.role.isRequired
| |
| |
Defined in
src/api/schemas/$ChatMLMessage.ts:5
$ChatMLTextContentPart
β’ Const $ChatMLTextContentPart: Object
Type declaration
| Name | Type |
|---|
| { text: { description: "Text content part" ; isRequired: true = true; type: "string" = "string" } ; type: { isRequired: true = true; type: "Enum" = "Enum" } } |
| { description: "Text content part" ; isRequired: true = true; type: "string" = "string" } |
properties.text.description
| |
properties.text.isRequired
| |
| |
| { isRequired: true = true; type: "Enum" = "Enum" } |
properties.type.isRequired
| |
| |
Defined in
src/api/schemas/$ChatMLTextContentPart.ts:5
$ChatResponse
β’ Const $ChatResponse: Object
Type declaration
| Name | Type |
|---|
| "Represents a chat completion response returned by model, based on the provided input."
|
| { doc_ids: { isRequired: true = true; type: "DocIds" = "DocIds" } ; finish_reason: { isRequired: true = true; type: "Enum" = "Enum" } ; id: { description: "A unique identifier for the chat completion." ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; jobs: { contains: { format: "uuid" = "uuid"; type: "string" = "string" } ; type: "array" = "array" } ; response: { contains: { contains: { type: "ChatMLMessage" = "ChatMLMessage" } ; type: "array" = "array" } ; isRequired: true = true; type: "array" = "array" } ; usage: { isRequired: true = true; type: "CompletionUsage" = "CompletionUsage" } } |
| { isRequired: true = true; type: "DocIds" = "DocIds" } |
properties.doc_ids.isRequired
| |
| |
| { isRequired: true = true; type: "Enum" = "Enum" } |
properties.finish_reason.isRequired
| |
properties.finish_reason.type
| |
| { description: "A unique identifier for the chat completion." ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.id.description
| "A unique identifier for the chat completion."
|
| |
| |
| |
| { contains: { format: "uuid" = "uuid"; type: "string" = "string" } ; type: "array" = "array" } |
| { format: "uuid" = "uuid"; type: "string" = "string" } |
properties.jobs.contains.format
| |
properties.jobs.contains.type
| |
| |
| { contains: { contains: { type: "ChatMLMessage" = "ChatMLMessage" } ; type: "array" = "array" } ; isRequired: true = true; type: "array" = "array" } |
properties.response.contains
| { contains: { type: "ChatMLMessage" = "ChatMLMessage" } ; type: "array" = "array" } |
properties.response.contains.contains
| { type: "ChatMLMessage" = "ChatMLMessage" } |
properties.response.contains.contains.type
| |
properties.response.contains.type
| |
properties.response.isRequired
| |
| |
| { isRequired: true = true; type: "CompletionUsage" = "CompletionUsage" } |
properties.usage.isRequired
| |
| |
Defined in
src/api/schemas/$ChatResponse.ts:5
$ChatSettings
β’ Const $ChatSettings: Object
Type declaration
| Name | Type |
|---|
| { frequency_penalty: { description: "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 1 = 1; minimum: -1 = -1; type: "number" = "number" } ; length_penalty: { description: "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. " ; isNullable: true = true; maximum: 2 = 2; type: "number" = "number" } ; logit_bias: { contains: { type: "number" = "number" } ; isNullable: true = true; type: "dictionary" = "dictionary" } ; max_tokens: { description: "The maximum number of tokens to generate in the chat completion.\n The total length of input tokens and generated tokens is limited by the model's context length.\n " ; isNullable: true = true; maximum: 16384 = 16384; minimum: 1 = 1; type: "number" = "number" } ; min_p: { description: "Minimum probability compared to leading token to be considered" ; exclusiveMaximum: true = true; maximum: 1 = 1; type: "number" = "number" } ; presence_penalty: { description: "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 1 = 1; minimum: -1 = -1; type: "number" = "number" } ; preset: { type: "Enum" = "Enum" } ; repetition_penalty: { description: "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 2 = 2; type: "number" = "number" } ; response_format: { description: "An object specifying the format that the model must output.\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n " ; properties: { pattern: { description: "Regular expression pattern to use if `type` is `\"regex\"`" ; type: "string" = "string" } ; schema: { description: "JSON Schema to use if `type` is `\"json_object\"`" ; properties: {} = {} } ; type: { type: "Enum" = "Enum" } } } ; seed: { description: "This feature is in Beta.\n If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n " ; isNullable: true = true; maximum: 9999 = 9999; minimum: -1 = -1; type: "number" = "number" } ; stop: { contains: readonly [{ isNullable: true = true; type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] ; description: "Up to 4 sequences where the API will stop generating further tokens.\n " ; type: "one-of" = "one-of" } ; stream: { description: "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n " ; isNullable: true = true; type: "boolean" = "boolean" } ; temperature: { description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." ; isNullable: true = true; maximum: 2 = 2; type: "number" = "number" } ; top_p: { description: "Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both." ; exclusiveMinimum: true = true; isNullable: true = true; maximum: 1 = 1; type: "number" = "number" } } |
properties.frequency_penalty
| { description: "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 1 = 1; minimum: -1 = -1; type: "number" = "number" } |
properties.frequency_penalty.description
| "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."
|
properties.frequency_penalty.isNullable
| |
properties.frequency_penalty.maximum
| |
properties.frequency_penalty.minimum
| |
properties.frequency_penalty.type
| |
properties.length_penalty
| { description: "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. " ; isNullable: true = true; maximum: 2 = 2; type: "number" = "number" } |
properties.length_penalty.description
| "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize number of tokens generated. "
|
properties.length_penalty.isNullable
| |
properties.length_penalty.maximum
| |
properties.length_penalty.type
| |
| { contains: { type: "number" = "number" } ; isNullable: true = true; type: "dictionary" = "dictionary" } |
properties.logit_bias.contains
| { type: "number" = "number" } |
properties.logit_bias.contains.type
| |
properties.logit_bias.isNullable
| |
properties.logit_bias.type
| |
| { description: "The maximum number of tokens to generate in the chat completion.\n The total length of input tokens and generated tokens is limited by the model's context length.\n " ; isNullable: true = true; maximum: 16384 = 16384; minimum: 1 = 1; type: "number" = "number" } |
properties.max_tokens.description
| "The maximum number of tokens to generate in the chat completion.\n The total length of input tokens and generated tokens is limited by the model's context length.\n "
|
properties.max_tokens.isNullable
| |
properties.max_tokens.maximum
| |
properties.max_tokens.minimum
| |
properties.max_tokens.type
| |
| { description: "Minimum probability compared to leading token to be considered" ; exclusiveMaximum: true = true; maximum: 1 = 1; type: "number" = "number" } |
properties.min_p.description
| "Minimum probability compared to leading token to be considered"
|
properties.min_p.exclusiveMaximum
| |
| |
| |
properties.presence_penalty
| { description: "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 1 = 1; minimum: -1 = -1; type: "number" = "number" } |
properties.presence_penalty.description
| "(OpenAI-like) Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."
|
properties.presence_penalty.isNullable
| |
properties.presence_penalty.maximum
| |
properties.presence_penalty.minimum
| |
properties.presence_penalty.type
| |
| { type: "Enum" = "Enum" } |
| |
properties.repetition_penalty
| { description: "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim." ; isNullable: true = true; maximum: 2 = 2; type: "number" = "number" } |
properties.repetition_penalty.description
| "(Huggingface-like) Number between 0 and 2.0. 1.0 is neutral and values larger than that penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."
|
properties.repetition_penalty.isNullable
| |
properties.repetition_penalty.maximum
| |
properties.repetition_penalty.type
| |
properties.response_format
| { description: "An object specifying the format that the model must output.\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n " ; properties: { pattern: { description: "Regular expression pattern to use if `type` is `\"regex\"`" ; type: "string" = "string" } ; schema: { description: "JSON Schema to use if `type` is `\"json_object\"`" ; properties: {} = {} } ; type: { type: "Enum" = "Enum" } } } |
properties.response_format.description
| "An object specifying the format that the model must output.\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n "
|
properties.response_format.properties
| { pattern: { description: "Regular expression pattern to use if `type` is `\"regex\"`" ; type: "string" = "string" } ; schema: { description: "JSON Schema to use if `type` is `\"json_object\"`" ; properties: {} = {} } ; type: { type: "Enum" = "Enum" } } |
properties.response_format.properties.pattern
| { description: "Regular expression pattern to use if `type` is `\"regex\"`" ; type: "string" = "string" } |
properties.response_format.properties.pattern.description
| "Regular expression pattern to use if `type` is `\"regex\"`"
|
properties.response_format.properties.pattern.type
| |
properties.response_format.properties.schema
| { description: "JSON Schema to use if `type` is `\"json_object\"`" ; properties: {} = {} } |
properties.response_format.properties.schema.description
| "JSON Schema to use if `type` is `\"json_object\"`"
|
properties.response_format.properties.schema.properties
| |
properties.response_format.properties.type
| { type: "Enum" = "Enum" } |
properties.response_format.properties.type.type
| |
| { description: "This feature is in Beta.\n If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n " ; isNullable: true = true; maximum: 9999 = 9999; minimum: -1 = -1; type: "number" = "number" } |
properties.seed.description
| "This feature is in Beta.\n If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n "
|
properties.seed.isNullable
| |
| |
| |
| |
| { contains: readonly [{ isNullable: true = true; type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] ; description: "Up to 4 sequences where the API will stop generating further tokens.\n " ; type: "one-of" = "one-of" } |
| readonly [{ isNullable: true = true; type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] |
properties.stop.description
| "Up to 4 sequences where the API will stop generating further tokens.\n "
|
| |
| { description: "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n " ; isNullable: true = true; type: "boolean" = "boolean" } |
properties.stream.description
| "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n "
|
properties.stream.isNullable
| |
| |
| { description: "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic." ; isNullable: true = true; maximum: 2 = 2; type: "number" = "number" } |
properties.temperature.description
| "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic."
|
properties.temperature.isNullable
| |
properties.temperature.maximum
| |
properties.temperature.type
| |
| { description: "Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both." ; exclusiveMinimum: true = true; isNullable: true = true; maximum: 1 = 1; type: "number" = "number" } |
properties.top_p.description
| "Defaults to 1 An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both."
|
properties.top_p.exclusiveMinimum
| |
properties.top_p.isNullable
| |
| |
| |
Defined in
src/api/schemas/$ChatSettings.ts:5
$CompletionUsage
β’ Const $CompletionUsage: Object
Type declaration
| Name | Type |
|---|
| "Usage statistics for the completion request."
|
| { completion_tokens: { description: "Number of tokens in the generated completion." ; isRequired: true = true; type: "number" = "number" } ; prompt_tokens: { description: "Number of tokens in the prompt." ; isRequired: true = true; type: "number" = "number" } ; total_tokens: { description: "Total number of tokens used in the request (prompt + completion)." ; isRequired: true = true; type: "number" = "number" } } |
properties.completion_tokens
| { description: "Number of tokens in the generated completion." ; isRequired: true = true; type: "number" = "number" } |
properties.completion_tokens.description
| "Number of tokens in the generated completion."
|
properties.completion_tokens.isRequired
| |
properties.completion_tokens.type
| |
| { description: "Number of tokens in the prompt." ; isRequired: true = true; type: "number" = "number" } |
properties.prompt_tokens.description
| "Number of tokens in the prompt."
|
properties.prompt_tokens.isRequired
| |
properties.prompt_tokens.type
| |
| { description: "Total number of tokens used in the request (prompt + completion)." ; isRequired: true = true; type: "number" = "number" } |
properties.total_tokens.description
| "Total number of tokens used in the request (prompt + completion)."
|
properties.total_tokens.isRequired
| |
properties.total_tokens.type
| |
Defined in
src/api/schemas/$CompletionUsage.ts:5
$CreateAgentRequest
β’ Const $CreateAgentRequest: Object
Type declaration
| Name | Type |
|---|
| "A valid request payload for creating an agent"
|
| { about: { description: "About the agent" ; type: "string" = "string" } ; default_settings: { description: "Default model settings to start every session with" ; type: "AgentDefaultSettings" = "AgentDefaultSettings" } ; docs: { contains: { type: "CreateDoc" = "CreateDoc" } ; type: "array" = "array" } ; instructions: { contains: readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] ; description: "Instructions for the agent" ; type: "one-of" = "one-of" } ; metadata: { description: "(Optional) metadata" ; properties: {} = {} } ; model: { description: "Name of the model that the agent is supposed to use" ; type: "string" = "string" } ; name: { description: "Name of the agent" ; isRequired: true = true; type: "string" = "string" } ; tools: { contains: { type: "CreateToolRequest" = "CreateToolRequest" } ; type: "array" = "array" } } |
| { description: "About the agent" ; type: "string" = "string" } |
properties.about.description
| |
| |
properties.default_settings
| { description: "Default model settings to start every session with" ; type: "AgentDefaultSettings" = "AgentDefaultSettings" } |
properties.default_settings.description
| "Default model settings to start every session with"
|
properties.default_settings.type
| |
| { contains: { type: "CreateDoc" = "CreateDoc" } ; type: "array" = "array" } |
| { type: "CreateDoc" = "CreateDoc" } |
properties.docs.contains.type
| |
| |
| { contains: readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] ; description: "Instructions for the agent" ; type: "one-of" = "one-of" } |
properties.instructions.contains
| readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] |
properties.instructions.description
| "Instructions for the agent"
|
properties.instructions.type
| |
| { description: "(Optional) metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "Name of the model that the agent is supposed to use" ; type: "string" = "string" } |
properties.model.description
| "Name of the model that the agent is supposed to use"
|
| |
| { description: "Name of the agent" ; isRequired: true = true; type: "string" = "string" } |
properties.name.description
| |
properties.name.isRequired
| |
| |
| { contains: { type: "CreateToolRequest" = "CreateToolRequest" } ; type: "array" = "array" } |
properties.tools.contains
| { type: "CreateToolRequest" = "CreateToolRequest" } |
properties.tools.contains.type
| |
| |
Defined in
src/api/schemas/$CreateAgentRequest.ts:5
$CreateDoc
β’ Const $CreateDoc: Object
Type declaration
| Name | Type |
|---|
| { content: { contains: readonly [{ contains: { minItems: 1 = 1; type: "string" = "string" } ; type: "array" = "array" }, { description: "A single document chunk" ; type: "string" = "string" }] ; description: "Information content" ; isRequired: true = true; type: "one-of" = "one-of" } ; metadata: { description: "Optional metadata" ; properties: {} = {} } ; title: { description: "Title describing what this bit of information contains" ; isRequired: true = true; type: "string" = "string" } } |
| { contains: readonly [{ contains: { minItems: 1 = 1; type: "string" = "string" } ; type: "array" = "array" }, { description: "A single document chunk" ; type: "string" = "string" }] ; description: "Information content" ; isRequired: true = true; type: "one-of" = "one-of" } |
properties.content.contains
| readonly [{ contains: { minItems: 1 = 1; type: "string" = "string" } ; type: "array" = "array" }, { description: "A single document chunk" ; type: "string" = "string" }] |
properties.content.description
| |
properties.content.isRequired
| |
| |
| { description: "Optional metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "Title describing what this bit of information contains" ; isRequired: true = true; type: "string" = "string" } |
properties.title.description
| "Title describing what this bit of information contains"
|
properties.title.isRequired
| |
| |
Defined in
src/api/schemas/$CreateDoc.ts:5
$CreateSessionRequest
β’ Const $CreateSessionRequest: Object
Type declaration
| Name | Type |
|---|
| "A valid request payload for creating a session"
|
| { agent_id: { description: "Agent ID of agent to associate with this session" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; context_overflow: { description: "Action to start on context window overflow" ; type: "string" = "string" } ; metadata: { description: "Optional metadata" ; properties: {} = {} } ; render_templates: { description: "Render system and assistant message content as jinja templates" ; type: "boolean" = "boolean" } ; situation: { description: "A specific situation that sets the background for this session" ; type: "string" = "string" } ; token_budget: { description: "Threshold value for the adaptive context functionality" ; type: "number" = "number" } ; user_id: { description: "(Optional) User ID of user to associate with this session" ; format: "uuid" = "uuid"; type: "string" = "string" } } |
| { description: "Agent ID of agent to associate with this session" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.agent_id.description
| "Agent ID of agent to associate with this session"
|
properties.agent_id.format
| |
properties.agent_id.isRequired
| |
| |
properties.context_overflow
| { description: "Action to start on context window overflow" ; type: "string" = "string" } |
properties.context_overflow.description
| "Action to start on context window overflow"
|
properties.context_overflow.type
| |
| { description: "Optional metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
properties.render_templates
| { description: "Render system and assistant message content as jinja templates" ; type: "boolean" = "boolean" } |
properties.render_templates.description
| "Render system and assistant message content as jinja templates"
|
properties.render_templates.type
| |
| { description: "A specific situation that sets the background for this session" ; type: "string" = "string" } |
properties.situation.description
| "A specific situation that sets the background for this session"
|
properties.situation.type
| |
| { description: "Threshold value for the adaptive context functionality" ; type: "number" = "number" } |
properties.token_budget.description
| "Threshold value for the adaptive context functionality"
|
properties.token_budget.type
| |
| { description: "(Optional) User ID of user to associate with this session" ; format: "uuid" = "uuid"; type: "string" = "string" } |
properties.user_id.description
| "(Optional) User ID of user to associate with this session"
|
properties.user_id.format
| |
| |
Defined in
src/api/schemas/$CreateSessionRequest.ts:5
$CreateToolRequest
β’ Const $CreateToolRequest: Object
Type declaration
| Name | Type |
|---|
| { function: { contains: readonly [{ type: "FunctionDef" = "FunctionDef" }] ; description: "Function definition and parameters" ; isRequired: true = true; type: "one-of" = "one-of" } ; type: { isRequired: true = true; type: "Enum" = "Enum" } } |
| { contains: readonly [{ type: "FunctionDef" = "FunctionDef" }] ; description: "Function definition and parameters" ; isRequired: true = true; type: "one-of" = "one-of" } |
properties.function.contains
| readonly [{ type: "FunctionDef" = "FunctionDef" }] |
properties.function.description
| "Function definition and parameters"
|
properties.function.isRequired
| |
| |
| { isRequired: true = true; type: "Enum" = "Enum" } |
properties.type.isRequired
| |
| |
Defined in
src/api/schemas/$CreateToolRequest.ts:5
$CreateUserRequest
β’ Const $CreateUserRequest: Object
Type declaration
| Name | Type |
|---|
| "A valid request payload for creating a user"
|
| { about: { description: "About the user" ; type: "string" = "string" } ; docs: { contains: { type: "CreateDoc" = "CreateDoc" } ; type: "array" = "array" } ; metadata: { description: "(Optional) metadata" ; properties: {} = {} } ; name: { description: "Name of the user" ; type: "string" = "string" } } |
| { description: "About the user" ; type: "string" = "string" } |
properties.about.description
| |
| |
| { contains: { type: "CreateDoc" = "CreateDoc" } ; type: "array" = "array" } |
| { type: "CreateDoc" = "CreateDoc" } |
properties.docs.contains.type
| |
| |
| { description: "(Optional) metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "Name of the user" ; type: "string" = "string" } |
properties.name.description
| |
| |
Defined in
src/api/schemas/$CreateUserRequest.ts:5
$Doc
β’ Const $Doc: Object
Type declaration
| Name | Type |
|---|
| { content: { contains: readonly [{ contains: { minItems: 1 = 1; type: "string" = "string" } ; type: "array" = "array" }, { description: "A single document chunk" ; type: "string" = "string" }] ; description: "Information content" ; isRequired: true = true; type: "one-of" = "one-of" } ; created_at: { description: "Doc created at" ; format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } ; id: { description: "ID of doc" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; metadata: { description: "optional metadata" ; properties: {} = {} } ; title: { description: "Title describing what this bit of information contains" ; isRequired: true = true; type: "string" = "string" } } |
| { contains: readonly [{ contains: { minItems: 1 = 1; type: "string" = "string" } ; type: "array" = "array" }, { description: "A single document chunk" ; type: "string" = "string" }] ; description: "Information content" ; isRequired: true = true; type: "one-of" = "one-of" } |
properties.content.contains
| readonly [{ contains: { minItems: 1 = 1; type: "string" = "string" } ; type: "array" = "array" }, { description: "A single document chunk" ; type: "string" = "string" }] |
properties.content.description
| |
properties.content.isRequired
| |
| |
| { description: "Doc created at" ; format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } |
properties.created_at.description
| |
properties.created_at.format
| |
properties.created_at.isRequired
| |
properties.created_at.type
| |
| { description: "ID of doc" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.id.description
| |
| |
| |
| |
| { description: "optional metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "Title describing what this bit of information contains" ; isRequired: true = true; type: "string" = "string" } |
properties.title.description
| "Title describing what this bit of information contains"
|
properties.title.isRequired
| |
| |
Defined in
src/api/schemas/$Doc.ts:5
$DocIds
β’ Const $DocIds: Object
Type declaration
| Name | Type |
|---|
| { agent_doc_ids: { contains: { type: "string" = "string" } ; isRequired: true = true; type: "array" = "array" } ; user_doc_ids: { contains: { type: "string" = "string" } ; isRequired: true = true; type: "array" = "array" } } |
| { contains: { type: "string" = "string" } ; isRequired: true = true; type: "array" = "array" } |
properties.agent_doc_ids.contains
| { type: "string" = "string" } |
properties.agent_doc_ids.contains.type
| |
properties.agent_doc_ids.isRequired
| |
properties.agent_doc_ids.type
| |
| { contains: { type: "string" = "string" } ; isRequired: true = true; type: "array" = "array" } |
properties.user_doc_ids.contains
| { type: "string" = "string" } |
properties.user_doc_ids.contains.type
| |
properties.user_doc_ids.isRequired
| |
properties.user_doc_ids.type
| |
Defined in
src/api/schemas/$DocIds.ts:5
$FunctionCallOption
β’ Const $FunctionCallOption: Object
Type declaration
| Name | Type |
|---|
| "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n "
|
| { name: { description: "The name of the function to call." ; isRequired: true = true; type: "string" = "string" } } |
| { description: "The name of the function to call." ; isRequired: true = true; type: "string" = "string" } |
properties.name.description
| "The name of the function to call."
|
properties.name.isRequired
| |
| |
Defined in
src/api/schemas/$FunctionCallOption.ts:5
$FunctionDef
β’ Const $FunctionDef: Object
Type declaration
| Name | Type |
|---|
| { description: { description: "A description of what the function does, used by the model to choose when and how to call the function." ; type: "string" = "string" } ; name: { description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." ; isRequired: true = true; type: "string" = "string" } ; parameters: { description: "Parameters accepeted by this function" ; isRequired: true = true; type: "FunctionParameters" = "FunctionParameters" } } |
| { description: "A description of what the function does, used by the model to choose when and how to call the function." ; type: "string" = "string" } |
properties.description.description
| "A description of what the function does, used by the model to choose when and how to call the function."
|
properties.description.type
| |
| { description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." ; isRequired: true = true; type: "string" = "string" } |
properties.name.description
| "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."
|
properties.name.isRequired
| |
| |
| { description: "Parameters accepeted by this function" ; isRequired: true = true; type: "FunctionParameters" = "FunctionParameters" } |
properties.parameters.description
| "Parameters accepeted by this function"
|
properties.parameters.isRequired
| |
properties.parameters.type
| |
Defined in
src/api/schemas/$FunctionDef.ts:5
$FunctionParameters
β’ Const $FunctionParameters: Object
Type declaration
Defined in
src/api/schemas/$FunctionParameters.ts:5
$InputChatMLMessage
β’ Const $InputChatMLMessage: Object
Type declaration
| Name | Type |
|---|
| { content: { contains: readonly [{ type: "string" = "string" }] ; description: "ChatML content" ; isRequired: true = true; type: "one-of" = "one-of" } ; continue: { description: "Whether to continue this message or return a new one" ; type: "boolean" = "boolean" } ; name: { description: "ChatML name" ; type: "string" = "string" } ; role: { isRequired: true = true; type: "Enum" = "Enum" } } |
| { contains: readonly [{ type: "string" = "string" }] ; description: "ChatML content" ; isRequired: true = true; type: "one-of" = "one-of" } |
properties.content.contains
| readonly [{ type: "string" = "string" }] |
properties.content.description
| |
properties.content.isRequired
| |
| |
| { description: "Whether to continue this message or return a new one" ; type: "boolean" = "boolean" } |
properties.continue.description
| "Whether to continue this message or return a new one"
|
| |
| { description: "ChatML name" ; type: "string" = "string" } |
properties.name.description
| |
| |
| { isRequired: true = true; type: "Enum" = "Enum" } |
properties.role.isRequired
| |
| |
Defined in
src/api/schemas/$InputChatMLMessage.ts:5
$JobStatus
β’ Const $JobStatus: Object
Type declaration
| Name | Type |
|---|
| { created_at: { description: "Job created at (RFC-3339 format)" ; format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } ; has_progress: { description: "Whether this Job supports progress updates" ; type: "boolean" = "boolean" } ; id: { description: "Job id (UUID)" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; name: { description: "Name of the job" ; isRequired: true = true; type: "string" = "string" } ; progress: { description: "Progress percentage" ; maximum: 100 = 100; type: "number" = "number" } ; reason: { description: "Reason for current state" ; type: "string" = "string" } ; state: { isRequired: true = true; type: "Enum" = "Enum" } ; updated_at: { description: "Job updated at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } } |
| { description: "Job created at (RFC-3339 format)" ; format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } |
properties.created_at.description
| "Job created at (RFC-3339 format)"
|
properties.created_at.format
| |
properties.created_at.isRequired
| |
properties.created_at.type
| |
| { description: "Whether this Job supports progress updates" ; type: "boolean" = "boolean" } |
properties.has_progress.description
| "Whether this Job supports progress updates"
|
properties.has_progress.type
| |
| { description: "Job id (UUID)" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.id.description
| |
| |
| |
| |
| { description: "Name of the job" ; isRequired: true = true; type: "string" = "string" } |
properties.name.description
| |
properties.name.isRequired
| |
| |
| { description: "Progress percentage" ; maximum: 100 = 100; type: "number" = "number" } |
properties.progress.description
| |
properties.progress.maximum
| |
| |
| { description: "Reason for current state" ; type: "string" = "string" } |
properties.reason.description
| "Reason for current state"
|
| |
| { isRequired: true = true; type: "Enum" = "Enum" } |
properties.state.isRequired
| |
| |
| { description: "Job updated at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } |
properties.updated_at.description
| "Job updated at (RFC-3339 format)"
|
properties.updated_at.format
| |
properties.updated_at.type
| |
Defined in
src/api/schemas/$JobStatus.ts:5
$Memory
β’ Const $Memory: Object
Type declaration
| Name | Type |
|---|
| { agent_id: { description: "ID of the agent" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; content: { description: "Content of the memory" ; isRequired: true = true; type: "string" = "string" } ; created_at: { description: "Memory created at (RFC-3339 format)" ; format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } ; entities: { contains: { properties: {} = {} } ; isRequired: true = true; type: "array" = "array" } ; id: { description: "Memory id (UUID)" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; last_accessed_at: { description: "Memory last accessed at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } ; sentiment: { description: "Sentiment (valence) of the memory on a scale of -1 to 1" ; maximum: 1 = 1; minimum: -1 = -1; type: "number" = "number" } ; timestamp: { description: "Memory happened at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } ; user_id: { description: "ID of the user" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } } |
| { description: "ID of the agent" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.agent_id.description
| |
properties.agent_id.format
| |
properties.agent_id.isRequired
| |
| |
| { description: "Content of the memory" ; isRequired: true = true; type: "string" = "string" } |
properties.content.description
| |
properties.content.isRequired
| |
| |
| { description: "Memory created at (RFC-3339 format)" ; format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } |
properties.created_at.description
| "Memory created at (RFC-3339 format)"
|
properties.created_at.format
| |
properties.created_at.isRequired
| |
properties.created_at.type
| |
| { contains: { properties: {} = {} } ; isRequired: true = true; type: "array" = "array" } |
properties.entities.contains
| |
properties.entities.contains.properties
| |
properties.entities.isRequired
| |
| |
| { description: "Memory id (UUID)" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.id.description
| |
| |
| |
| |
properties.last_accessed_at
| { description: "Memory last accessed at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } |
properties.last_accessed_at.description
| "Memory last accessed at (RFC-3339 format)"
|
properties.last_accessed_at.format
| |
properties.last_accessed_at.type
| |
| { description: "Sentiment (valence) of the memory on a scale of -1 to 1" ; maximum: 1 = 1; minimum: -1 = -1; type: "number" = "number" } |
properties.sentiment.description
| "Sentiment (valence) of the memory on a scale of -1 to 1"
|
properties.sentiment.maximum
| |
properties.sentiment.minimum
| |
properties.sentiment.type
| |
| { description: "Memory happened at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } |
properties.timestamp.description
| "Memory happened at (RFC-3339 format)"
|
properties.timestamp.format
| |
properties.timestamp.type
| |
| { description: "ID of the user" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.user_id.description
| |
properties.user_id.format
| |
properties.user_id.isRequired
| |
| |
Defined in
src/api/schemas/$Memory.ts:5
$MemoryAccessOptions
β’ Const $MemoryAccessOptions: Object
Type declaration
| Name | Type |
|---|
| { recall: { description: "Whether previous memories should be recalled or not" ; type: "boolean" = "boolean" } ; record: { description: "Whether this interaction should be recorded in history or not" ; type: "boolean" = "boolean" } ; remember: { description: "Whether this interaction should form memories or not" ; type: "boolean" = "boolean" } } |
| { description: "Whether previous memories should be recalled or not" ; type: "boolean" = "boolean" } |
properties.recall.description
| "Whether previous memories should be recalled or not"
|
| |
| { description: "Whether this interaction should be recorded in history or not" ; type: "boolean" = "boolean" } |
properties.record.description
| "Whether this interaction should be recorded in history or not"
|
| |
| { description: "Whether this interaction should form memories or not" ; type: "boolean" = "boolean" } |
properties.remember.description
| "Whether this interaction should form memories or not"
|
| |
Defined in
src/api/schemas/$MemoryAccessOptions.ts:5
$NamedToolChoice
β’ Const $NamedToolChoice: Object
Type declaration
| Name | Type |
|---|
| "Specifies a tool the model should use. Use to force the model to call a specific function."
|
| { function: { isRequired: true = true; properties: { name: { description: "The name of the function to call." ; isRequired: true = true; type: "string" = "string" } } } ; type: { isRequired: true = true; type: "Enum" = "Enum" } } |
| { isRequired: true = true; properties: { name: { description: "The name of the function to call." ; isRequired: true = true; type: "string" = "string" } } } |
properties.function.isRequired
| |
properties.function.properties
| { name: { description: "The name of the function to call." ; isRequired: true = true; type: "string" = "string" } } |
properties.function.properties.name
| { description: "The name of the function to call." ; isRequired: true = true; type: "string" = "string" } |
properties.function.properties.name.description
| "The name of the function to call."
|
properties.function.properties.name.isRequired
| |
properties.function.properties.name.type
| |
| { isRequired: true = true; type: "Enum" = "Enum" } |
properties.type.isRequired
| |
| |
Defined in
src/api/schemas/$NamedToolChoice.ts:5
$PartialFunctionDef
β’ Const $PartialFunctionDef: Object
Type declaration
| Name | Type |
|---|
| { description: { description: "A description of what the function does, used by the model to choose when and how to call the function." ; type: "string" = "string" } ; name: { description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." ; type: "string" = "string" } ; parameters: { description: "Parameters accepeted by this function" ; type: "FunctionParameters" = "FunctionParameters" } } |
| { description: "A description of what the function does, used by the model to choose when and how to call the function." ; type: "string" = "string" } |
properties.description.description
| "A description of what the function does, used by the model to choose when and how to call the function."
|
properties.description.type
| |
| { description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." ; type: "string" = "string" } |
properties.name.description
| "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."
|
| |
| { description: "Parameters accepeted by this function" ; type: "FunctionParameters" = "FunctionParameters" } |
properties.parameters.description
| "Parameters accepeted by this function"
|
properties.parameters.type
| |
Defined in
src/api/schemas/$PartialFunctionDef.ts:5
$PatchAgentRequest
β’ Const $PatchAgentRequest: Object
Type declaration
| Name | Type |
|---|
| "A request for patching an agent"
|
| { about: { description: "About the agent" ; type: "string" = "string" } ; default_settings: { description: "Default model settings to start every session with" ; type: "AgentDefaultSettings" = "AgentDefaultSettings" } ; instructions: { contains: readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] ; description: "Instructions for the agent" ; type: "one-of" = "one-of" } ; metadata: { description: "Optional metadata" ; properties: {} = {} } ; model: { description: "Name of the model that the agent is supposed to use" ; type: "string" = "string" } ; name: { description: "Name of the agent" ; type: "string" = "string" } } |
| { description: "About the agent" ; type: "string" = "string" } |
properties.about.description
| |
| |
properties.default_settings
| { description: "Default model settings to start every session with" ; type: "AgentDefaultSettings" = "AgentDefaultSettings" } |
properties.default_settings.description
| "Default model settings to start every session with"
|
properties.default_settings.type
| |
| { contains: readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] ; description: "Instructions for the agent" ; type: "one-of" = "one-of" } |
properties.instructions.contains
| readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] |
properties.instructions.description
| "Instructions for the agent"
|
properties.instructions.type
| |
| { description: "Optional metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "Name of the model that the agent is supposed to use" ; type: "string" = "string" } |
properties.model.description
| "Name of the model that the agent is supposed to use"
|
| |
| { description: "Name of the agent" ; type: "string" = "string" } |
properties.name.description
| |
| |
Defined in
src/api/schemas/$PatchAgentRequest.ts:5
$PatchSessionRequest
β’ Const $PatchSessionRequest: Object
Type declaration
| Name | Type |
|---|
| "A request for patching a session"
|
| { context_overflow: { description: "Action to start on context window overflow" ; type: "string" = "string" } ; metadata: { description: "Optional metadata" ; properties: {} = {} } ; situation: { description: "Updated situation for this session" ; type: "string" = "string" } ; token_budget: { description: "Threshold value for the adaptive context functionality" ; type: "number" = "number" } } |
properties.context_overflow
| { description: "Action to start on context window overflow" ; type: "string" = "string" } |
properties.context_overflow.description
| "Action to start on context window overflow"
|
properties.context_overflow.type
| |
| { description: "Optional metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "Updated situation for this session" ; type: "string" = "string" } |
properties.situation.description
| "Updated situation for this session"
|
properties.situation.type
| |
| { description: "Threshold value for the adaptive context functionality" ; type: "number" = "number" } |
properties.token_budget.description
| "Threshold value for the adaptive context functionality"
|
properties.token_budget.type
| |
Defined in
src/api/schemas/$PatchSessionRequest.ts:5
$PatchToolRequest
β’ Const $PatchToolRequest: Object
Type declaration
| Name | Type |
|---|
| { function: { description: "Function definition and parameters" ; isRequired: true = true; type: "PartialFunctionDef" = "PartialFunctionDef" } } |
| { description: "Function definition and parameters" ; isRequired: true = true; type: "PartialFunctionDef" = "PartialFunctionDef" } |
properties.function.description
| "Function definition and parameters"
|
properties.function.isRequired
| |
| |
Defined in
src/api/schemas/$PatchToolRequest.ts:5
$PatchUserRequest
β’ Const $PatchUserRequest: Object
Type declaration
| Name | Type |
|---|
| "A request for patching a user"
|
| { about: { description: "About the user" ; type: "string" = "string" } ; metadata: { description: "Optional metadata" ; properties: {} = {} } ; name: { description: "Name of the user" ; type: "string" = "string" } } |
| { description: "About the user" ; type: "string" = "string" } |
properties.about.description
| |
| |
| { description: "Optional metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "Name of the user" ; type: "string" = "string" } |
properties.name.description
| |
| |
Defined in
src/api/schemas/$PatchUserRequest.ts:5
$ResourceCreatedResponse
β’ Const $ResourceCreatedResponse: Object
Type declaration
| Name | Type |
|---|
| { created_at: { format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } ; id: { format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; jobs: { contains: { format: "uuid" = "uuid"; type: "string" = "string" } ; type: "array" = "array" } } |
| { format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } |
properties.created_at.format
| |
properties.created_at.isRequired
| |
properties.created_at.type
| |
| { format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
| |
| |
| |
| { contains: { format: "uuid" = "uuid"; type: "string" = "string" } ; type: "array" = "array" } |
| { format: "uuid" = "uuid"; type: "string" = "string" } |
properties.jobs.contains.format
| |
properties.jobs.contains.type
| |
| |
Defined in
src/api/schemas/$ResourceCreatedResponse.ts:5
$ResourceDeletedResponse
β’ Const $ResourceDeletedResponse: Object
Type declaration
| Name | Type |
|---|
| { deleted_at: { format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } ; id: { format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; jobs: { contains: { format: "uuid" = "uuid"; type: "string" = "string" } ; type: "array" = "array" } } |
| { format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } |
properties.deleted_at.format
| |
properties.deleted_at.isRequired
| |
properties.deleted_at.type
| |
| { format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
| |
| |
| |
| { contains: { format: "uuid" = "uuid"; type: "string" = "string" } ; type: "array" = "array" } |
| { format: "uuid" = "uuid"; type: "string" = "string" } |
properties.jobs.contains.format
| |
properties.jobs.contains.type
| |
| |
Defined in
src/api/schemas/$ResourceDeletedResponse.ts:5
$ResourceUpdatedResponse
β’ Const $ResourceUpdatedResponse: Object
Type declaration
| Name | Type |
|---|
| { id: { format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; jobs: { contains: { format: "uuid" = "uuid"; type: "string" = "string" } ; type: "array" = "array" } ; updated_at: { format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } } |
| { format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
| |
| |
| |
| { contains: { format: "uuid" = "uuid"; type: "string" = "string" } ; type: "array" = "array" } |
| { format: "uuid" = "uuid"; type: "string" = "string" } |
properties.jobs.contains.format
| |
properties.jobs.contains.type
| |
| |
| { format: "date-time" = "date-time"; isRequired: true = true; type: "string" = "string" } |
properties.updated_at.format
| |
properties.updated_at.isRequired
| |
properties.updated_at.type
| |
Defined in
src/api/schemas/$ResourceUpdatedResponse.ts:5
$Session
β’ Const $Session: Object
Type declaration
| Name | Type |
|---|
| { agent_id: { description: "Agent ID of agent associated with this session" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; context_overflow: { description: "Action to start on context window overflow" ; type: "string" = "string" } ; created_at: { description: "Session created at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } ; id: { description: "Session id (UUID)" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; metadata: { description: "Optional metadata" ; properties: {} = {} } ; render_templates: { description: "Render system and assistant message content as jinja templates" ; type: "boolean" = "boolean" } ; situation: { description: "A specific situation that sets the background for this session" ; type: "string" = "string" } ; summary: { description: "(null at the beginning) - generated automatically after every interaction" ; type: "string" = "string" } ; token_budget: { description: "Threshold value for the adaptive context functionality" ; type: "number" = "number" } ; updated_at: { description: "Session updated at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } ; user_id: { description: "User ID of user associated with this session" ; format: "uuid" = "uuid"; type: "string" = "string" } } |
| { description: "Agent ID of agent associated with this session" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.agent_id.description
| "Agent ID of agent associated with this session"
|
properties.agent_id.format
| |
properties.agent_id.isRequired
| |
| |
properties.context_overflow
| { description: "Action to start on context window overflow" ; type: "string" = "string" } |
properties.context_overflow.description
| "Action to start on context window overflow"
|
properties.context_overflow.type
| |
| { description: "Session created at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } |
properties.created_at.description
| "Session created at (RFC-3339 format)"
|
properties.created_at.format
| |
properties.created_at.type
| |
| { description: "Session id (UUID)" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.id.description
| |
| |
| |
| |
| { description: "Optional metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
properties.render_templates
| { description: "Render system and assistant message content as jinja templates" ; type: "boolean" = "boolean" } |
properties.render_templates.description
| "Render system and assistant message content as jinja templates"
|
properties.render_templates.type
| |
| { description: "A specific situation that sets the background for this session" ; type: "string" = "string" } |
properties.situation.description
| "A specific situation that sets the background for this session"
|
properties.situation.type
| |
| { description: "(null at the beginning) - generated automatically after every interaction" ; type: "string" = "string" } |
properties.summary.description
| "(null at the beginning) - generated automatically after every interaction"
|
| |
| { description: "Threshold value for the adaptive context functionality" ; type: "number" = "number" } |
properties.token_budget.description
| "Threshold value for the adaptive context functionality"
|
properties.token_budget.type
| |
| { description: "Session updated at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } |
properties.updated_at.description
| "Session updated at (RFC-3339 format)"
|
properties.updated_at.format
| |
properties.updated_at.type
| |
| { description: "User ID of user associated with this session" ; format: "uuid" = "uuid"; type: "string" = "string" } |
properties.user_id.description
| "User ID of user associated with this session"
|
properties.user_id.format
| |
| |
Defined in
src/api/schemas/$Session.ts:5
$Suggestion
β’ Const $Suggestion: Object
Type declaration
| Name | Type |
|---|
| { content: { description: "The content of the suggestion" ; isRequired: true = true; type: "string" = "string" } ; created_at: { description: "Suggestion created at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } ; message_id: { description: "The message that produced it" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; session_id: { description: "Session this suggestion belongs to" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; target: { isRequired: true = true; type: "Enum" = "Enum" } } |
| { description: "The content of the suggestion" ; isRequired: true = true; type: "string" = "string" } |
properties.content.description
| "The content of the suggestion"
|
properties.content.isRequired
| |
| |
| { description: "Suggestion created at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } |
properties.created_at.description
| "Suggestion created at (RFC-3339 format)"
|
properties.created_at.format
| |
properties.created_at.type
| |
| { description: "The message that produced it" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.message_id.description
| "The message that produced it"
|
properties.message_id.format
| |
properties.message_id.isRequired
| |
properties.message_id.type
| |
| { description: "Session this suggestion belongs to" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.session_id.description
| "Session this suggestion belongs to"
|
properties.session_id.format
| |
properties.session_id.isRequired
| |
properties.session_id.type
| |
| { isRequired: true = true; type: "Enum" = "Enum" } |
properties.target.isRequired
| |
| |
Defined in
src/api/schemas/$Suggestion.ts:5
$Tool
β’ Const $Tool: Object
Type declaration
| Name | Type |
|---|
| { function: { contains: readonly [{ type: "FunctionDef" = "FunctionDef" }] ; description: "Function definition and parameters" ; isRequired: true = true; type: "one-of" = "one-of" } ; id: { description: "Tool ID" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; type: { isRequired: true = true; type: "Enum" = "Enum" } } |
| { contains: readonly [{ type: "FunctionDef" = "FunctionDef" }] ; description: "Function definition and parameters" ; isRequired: true = true; type: "one-of" = "one-of" } |
properties.function.contains
| readonly [{ type: "FunctionDef" = "FunctionDef" }] |
properties.function.description
| "Function definition and parameters"
|
properties.function.isRequired
| |
| |
| { description: "Tool ID" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.id.description
| |
| |
| |
| |
| { isRequired: true = true; type: "Enum" = "Enum" } |
properties.type.isRequired
| |
| |
Defined in
src/api/schemas/$Tool.ts:5
$ToolChoiceOption
β’ Const $ToolChoiceOption: Object
Type declaration
| Name | Type |
|---|
| readonly [{ type: "Enum" = "Enum" }, { type: "NamedToolChoice" = "NamedToolChoice" }] |
| "Controls which (if any) function is called by the model.\n `none` means the model will not call a function and instead generates a message.\n `auto` means the model can pick between generating a message or calling a function.\n Specifying a particular function via `{\"type: \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that function.\n `none` is the default when no functions are present. `auto` is the default if functions are present.\n "
|
| |
Defined in
src/api/schemas/$ToolChoiceOption.ts:5
$UpdateAgentRequest
β’ Const $UpdateAgentRequest: Object
Type declaration
| Name | Type |
|---|
| "A valid request payload for updating an agent"
|
| { about: { description: "About the agent" ; isRequired: true = true; type: "string" = "string" } ; default_settings: { description: "Default model settings to start every session with" ; type: "AgentDefaultSettings" = "AgentDefaultSettings" } ; instructions: { contains: readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] ; description: "Instructions for the agent" ; type: "one-of" = "one-of" } ; metadata: { description: "Optional metadata" ; properties: {} = {} } ; model: { description: "Name of the model that the agent is supposed to use" ; type: "string" = "string" } ; name: { description: "Name of the agent" ; isRequired: true = true; type: "string" = "string" } } |
| { description: "About the agent" ; isRequired: true = true; type: "string" = "string" } |
properties.about.description
| |
properties.about.isRequired
| |
| |
properties.default_settings
| { description: "Default model settings to start every session with" ; type: "AgentDefaultSettings" = "AgentDefaultSettings" } |
properties.default_settings.description
| "Default model settings to start every session with"
|
properties.default_settings.type
| |
| { contains: readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] ; description: "Instructions for the agent" ; type: "one-of" = "one-of" } |
properties.instructions.contains
| readonly [{ type: "string" = "string" }, { contains: { type: "string" = "string" } ; type: "array" = "array" }] |
properties.instructions.description
| "Instructions for the agent"
|
properties.instructions.type
| |
| { description: "Optional metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "Name of the model that the agent is supposed to use" ; type: "string" = "string" } |
properties.model.description
| "Name of the model that the agent is supposed to use"
|
| |
| { description: "Name of the agent" ; isRequired: true = true; type: "string" = "string" } |
properties.name.description
| |
properties.name.isRequired
| |
| |
Defined in
src/api/schemas/$UpdateAgentRequest.ts:5
$UpdateSessionRequest
β’ Const $UpdateSessionRequest: Object
Type declaration
| Name | Type |
|---|
| "A valid request payload for updating a session"
|
| { context_overflow: { description: "Action to start on context window overflow" ; type: "string" = "string" } ; metadata: { description: "Optional metadata" ; properties: {} = {} } ; situation: { description: "Updated situation for this session" ; isRequired: true = true; type: "string" = "string" } ; token_budget: { description: "Threshold value for the adaptive context functionality" ; type: "number" = "number" } } |
properties.context_overflow
| { description: "Action to start on context window overflow" ; type: "string" = "string" } |
properties.context_overflow.description
| "Action to start on context window overflow"
|
properties.context_overflow.type
| |
| { description: "Optional metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "Updated situation for this session" ; isRequired: true = true; type: "string" = "string" } |
properties.situation.description
| "Updated situation for this session"
|
properties.situation.isRequired
| |
properties.situation.type
| |
| { description: "Threshold value for the adaptive context functionality" ; type: "number" = "number" } |
properties.token_budget.description
| "Threshold value for the adaptive context functionality"
|
properties.token_budget.type
| |
Defined in
src/api/schemas/$UpdateSessionRequest.ts:5
$UpdateToolRequest
β’ Const $UpdateToolRequest: Object
Type declaration
| Name | Type |
|---|
| { function: { description: "Function definition and parameters" ; isRequired: true = true; type: "FunctionDef" = "FunctionDef" } } |
| { description: "Function definition and parameters" ; isRequired: true = true; type: "FunctionDef" = "FunctionDef" } |
properties.function.description
| "Function definition and parameters"
|
properties.function.isRequired
| |
| |
Defined in
src/api/schemas/$UpdateToolRequest.ts:5
$UpdateUserRequest
β’ Const $UpdateUserRequest: Object
Type declaration
| Name | Type |
|---|
| "A valid request payload for updating a user"
|
| { about: { description: "About the user" ; isRequired: true = true; type: "string" = "string" } ; metadata: { description: "Optional metadata" ; properties: {} = {} } ; name: { description: "Name of the user" ; isRequired: true = true; type: "string" = "string" } } |
| { description: "About the user" ; isRequired: true = true; type: "string" = "string" } |
properties.about.description
| |
properties.about.isRequired
| |
| |
| { description: "Optional metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "Name of the user" ; isRequired: true = true; type: "string" = "string" } |
properties.name.description
| |
properties.name.isRequired
| |
| |
Defined in
src/api/schemas/$UpdateUserRequest.ts:5
$User
β’ Const $User: Object
Type declaration
| Name | Type |
|---|
| { about: { description: "About the user" ; type: "string" = "string" } ; created_at: { description: "User created at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } ; id: { description: "User id (UUID)" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } ; metadata: { description: "(Optional) metadata" ; properties: {} = {} } ; name: { description: "Name of the user" ; type: "string" = "string" } ; updated_at: { description: "User updated at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } } |
| { description: "About the user" ; type: "string" = "string" } |
properties.about.description
| |
| |
| { description: "User created at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } |
properties.created_at.description
| "User created at (RFC-3339 format)"
|
properties.created_at.format
| |
properties.created_at.type
| |
| { description: "User id (UUID)" ; format: "uuid" = "uuid"; isRequired: true = true; type: "string" = "string" } |
properties.id.description
| |
| |
| |
| |
| { description: "(Optional) metadata" ; properties: {} = {} } |
properties.metadata.description
| |
properties.metadata.properties
| |
| { description: "Name of the user" ; type: "string" = "string" } |
properties.name.description
| |
| |
| { description: "User updated at (RFC-3339 format)" ; format: "date-time" = "date-time"; type: "string" = "string" } |
properties.updated_at.description
| "User updated at (RFC-3339 format)"
|
properties.updated_at.format
| |
properties.updated_at.type
| |
Defined in
src/api/schemas/$User.ts:5
$agent_id
β’ Const $agent_id: Object
Type declaration
Defined in
src/api/schemas/$agent_id.ts:5
$doc_id
β’ Const $doc_id: Object
Type declaration
Defined in
src/api/schemas/$doc_id.ts:5
$job_id
β’ Const $job_id: Object
Type declaration
Defined in
src/api/schemas/$job_id.ts:5
$memory_id
β’ Const $memory_id: Object
Type declaration
Defined in
src/api/schemas/$memory_id.ts:5
$message_id
β’ Const $message_id: Object
Type declaration
Defined in
src/api/schemas/$message_id.ts:5
$session_id
β’ Const $session_id: Object
Type declaration
Defined in
src/api/schemas/$session_id.ts:5
$tool_id
β’ Const $tool_id: Object
Type declaration
Defined in
src/api/schemas/$tool_id.ts:5
$user_id
β’ Const $user_id: Object
Type declaration
Defined in
src/api/schemas/$user_id.ts:5
OpenAPI
β’ Const OpenAPI: OpenAPIConfig
Defined in
src/api/core/OpenAPI.ts:22