@azure/openai-assistants package
Classes
AssistantsClient |
Tratamento de cliente assistente operações relacionadas. |
AzureKeyCredential |
Uma credencial baseada em chave estática que dá suporte à atualização do valor da chave subjacente. |
OpenAIKeyCredential |
A classe OpenAIKeyCredential representa uma chave de API OpenAI e é usada para autenticar em um cliente Assistentes para um ponto de extremidade OpenAI. |
Interfaces
Assistant |
Representa um assistente que pode chamar o modelo e usar ferramentas. |
AssistantCreationOptions |
Os detalhes da solicitação a serem usados ao criar um novo assistente. |
AssistantDeletionStatus |
O status de uma operação de exclusão de assistente. |
AssistantFile |
Informações sobre um arquivo anexado a um assistente, conforme usado por ferramentas que podem ler arquivos. |
AssistantFileDeletionStatus |
O status de uma operação de exclusão de arquivo assistente. |
AssistantThread |
Informações sobre um único thread associado a um assistente. |
AssistantThreadCreationOptions |
Os detalhes usados para criar um thread de assistente. |
AssistantsClientOptions |
Os detalhes usados para criar um cliente assistente * |
CancelRunOptions |
Os detalhes usados para cancelar uma execução. |
CodeInterpreterImageOutput |
Uma representação de uma saída de imagem emitida por uma ferramenta de interpretador de código em resposta a uma chamada de ferramenta pelo modelo. |
CodeInterpreterImageReference |
Uma referência de imagem emitida por uma ferramenta de interpretador de código em resposta a uma chamada de ferramenta pelo modelo. |
CodeInterpreterLogOutput |
Uma representação de uma saída de log emitida por uma ferramenta de interpretador de código em resposta a uma chamada de ferramenta pelo modelo. |
CodeInterpreterToolCall |
Um registro de uma chamada para uma ferramenta de interpretador de código, emitido pelo modelo na avaliação de uma ferramenta definida, que representa entradas e saídas consumidas e emitidas pelo interpretador de código. |
CodeInterpreterToolCallDetails |
As informações detalhadas sobre uma invocação do interpretador de código pelo modelo. |
CodeInterpreterToolDefinition |
As informações de definição de entrada para uma ferramenta de interpretador de código, conforme usado para configurar um assistente. |
CreateAndRunThreadOptions |
Os detalhes usados ao criar e executar imediatamente um novo thread assistente. |
CreateAssistantFileOptions |
Os detalhes usados para criar um arquivo assistente. |
CreateAssistantOptions |
Os detalhes usados para criar um assistente. |
CreateMessageOptions |
Os detalhes usados para criar uma mensagem. |
CreateRunOptions |
Os detalhes usados ao criar uma nova execução de um thread assistente. |
CreateRunRequestOptions |
Os detalhes usados para criar uma solicitação de execução. |
CreateThreadAndRunOptions |
Os detalhes usados para criar e executar um thread. |
CreateThreadOptions |
Os detalhes usados para criar um thread. |
DeleteAssistantFileOptions |
Os detalhes usados para excluir um arquivo assistente. |
DeleteAssistantOptions |
Os detalhes usados para excluir um assistente. |
DeleteFileOptions |
Os detalhes usados para excluir arquivos. |
DeleteThreadOptions |
Os detalhes usados para excluir um thread. |
DeletionStatus |
Uma representação abstrata de um resultado da operação de exclusão do OpenAI status. |
FileDeletionStatus |
Uma resposta status de uma operação de exclusão de arquivo. |
FileListResponse |
Os dados de resposta de uma operação de lista de arquivos. |
FunctionDefinition |
As informações de definição de entrada para uma função. |
FunctionToolCall |
Um registro de uma chamada para uma ferramenta de função, emitido pelo modelo na avaliação de uma ferramenta definida, que representa as entradas e a saída consumidas e emitidas pela função especificada. |
FunctionToolCallDetails |
As informações detalhadas sobre a função chamada pelo modelo. |
FunctionToolDefinition |
As informações de definição de entrada para uma ferramenta de função, conforme usado para configurar um assistente. |
GetAssistantFileOptions |
Os detalhes usados para obter um arquivo assistente. |
GetAssistantOptions |
Os detalhes usados para obter uma assistente. |
GetFileOptions |
Os detalhes usados para obter arquivos. |
GetMessageFileOptions |
Os detalhes usados para obter um arquivo de mensagem. |
GetMessageOptions |
Os detalhes usados para receber uma mensagem. |
GetRunOptions |
Os detalhes usados para obter uma execução. |
GetRunStepOptions |
Os detalhes usados para obter uma etapa de execução. |
GetThreadOptions |
Os detalhes usados para obter um thread. |
InputFile |
Representa um assistente que pode chamar o modelo e usar ferramentas. |
ListAssistantFilesOptions |
Os detalhes usados para listar assistente arquivos. |
ListAssistantsOptions |
Os detalhes usados para listar assistentes. |
ListFilesOptions |
Os detalhes usados para listar arquivos. |
ListMessageFilesOptions |
Os detalhes usados para listar arquivos de mensagem. |
ListMessagesOptions |
Os detalhes usados para listar mensagens. |
ListResponseOf |
Os dados de resposta de uma lista solicitada de itens. |
ListRunStepsOptions |
Os detalhes usados para listar as etapas de execução. |
ListRunsOptions |
Os detalhes usados para listar execuções. |
MessageFile |
Informações sobre um arquivo anexado a uma mensagem de thread assistente. |
MessageImageFileContent |
Uma representação do conteúdo do arquivo de imagem em uma mensagem de thread. |
MessageImageFileDetails |
Uma referência de imagem, conforme representado no conteúdo da mensagem de thread. |
MessageTextContent |
Uma representação de um item textual do conteúdo da mensagem de thread. |
MessageTextDetails |
O texto e as anotações associadas para um único item de assistente conteúdo da mensagem de thread. |
MessageTextFileCitationAnnotation |
Uma citação dentro da mensagem que aponta para uma citação específica de um Arquivo específico associado ao assistente ou à mensagem. Gerado quando o assistente usa a ferramenta de "recuperação" para pesquisar arquivos. |
MessageTextFileCitationDetails |
Uma representação de uma citação de texto baseada em arquivo, conforme usado em uma anotação baseada em arquivo do conteúdo da mensagem de thread de texto. |
MessageTextFilePathAnnotation |
Uma citação dentro da mensagem que aponta para um arquivo localizado em um caminho específico. |
MessageTextFilePathDetails |
Um encapsulamento de uma ID de arquivo de imagem, conforme usado pelo conteúdo da imagem da mensagem. |
RequiredAction |
Uma representação abstrata de uma ação necessária para que uma execução de thread assistente continue. |
RequiredFunctionToolCall |
Uma representação de uma chamada solicitada para uma ferramenta de função, necessária para que o modelo continue a avaliação de uma execução. |
RetrievalToolCall |
Um registro de uma chamada para uma ferramenta de recuperação, emitido pelo modelo na avaliação de uma ferramenta definida, que representa as ações de recuperação executadas. |
RetrievalToolDefinition |
As informações de definição de entrada para uma ferramenta de recuperação, conforme usado para configurar um assistente. |
RunError |
Os detalhes de um erro, conforme encontrado por uma execução de thread assistente. |
RunStep |
Informações detalhadas sobre uma única etapa de uma execução de thread assistente. |
RunStepError |
As informações de erro associadas a uma etapa de execução com falha. |
RunStepMessageCreationDetails |
As informações detalhadas associadas a uma etapa de execução de criação de mensagem. |
RunStepMessageCreationReference |
Os detalhes de uma mensagem criada como parte de uma etapa de execução. |
RunStepToolCallDetails |
As informações detalhadas associadas a uma etapa de execução que chama as ferramentas. |
SubmitToolOutputsDetails |
Os detalhes que descrevem as ferramentas que devem ser chamadas para enviar saídas de ferramenta. |
SubmitToolOutputsToRunOptions |
Os detalhes usados para enviar saídas de ferramenta para uma execução. |
ThreadDeletionStatus |
O status de uma operação de exclusão de thread. |
ThreadMessage |
Uma única mensagem existente em um thread assistente. |
ThreadRun |
Dados que representam uma única execução de avaliação de um thread assistente. |
ToolOutput |
Os dados fornecidos durante uma ferramenta geram envio para resolve chamadas de ferramenta pendentes e permitem que o modelo continue. |
UpdateAssistantOptions |
Os detalhes da solicitação a serem usados ao modificar um assistente existente. |
UpdateAssistantRequestOptions |
Os detalhes usados para atualizar um assistente. |
UpdateMessageOptions |
Os detalhes usados para atualizar uma mensagem. |
UpdateRunOptions |
Os detalhes usados para atualizar uma execução. |
UpdateThreadOptions |
Os detalhes usados para atualizar um thread. |
UploadFileOptions |
Os detalhes usados para carregar arquivos. |
Aliases de tipo
CodeInterpreterToolCallOutput |
Alias para CodeInterpreterToolCallOutput |
FilePurpose |
"fine-tune", "fine-tune-results", "assistants", "assistants_output" |
ListSortOrder |
"asc", "desc" |
MessageContent |
Alias para MessageContent |
MessageRole |
"user", "assistente" |
MessageTextAnnotation |
Alias para MessageTextAnnotation |
RequiredToolCall |
Alias para RequiredToolCall |
RunStatus |
"enfileirado", "in_progress", "requires_action", "cancelando", "cancelado", "com falha", "concluído", "expirado" |
RunStepDetails |
Alias para RunStepDetails |
RunStepErrorCode |
"server_error", "rate_limit_exceeded" |
RunStepStatus |
"in_progress", "cancelado", "falhou", "concluído", "expirado" |
RunStepType |
"message_creation", "tool_calls" |
ToolCall |
Alias para ToolCall |
ToolDefinition |
Uma representação abstrata de uma definição de ferramenta de entrada que um assistente pode usar. |
Azure SDK for JavaScript