@azure/openai-assistants package
Classes
| AssistantsClient |
Cliente que lida com operações relacionadas ao assistente. |
| 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 endpoint 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 do 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 novo thread do assistente. |
| AssistantsClientOptions |
Os detalhes usados para criar um cliente assistente * |
| CancelRunOptions |
Os detalhes usados para cancelar uma corrida. |
| 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 de interpretador de código pelo modelo. |
| CodeInterpreterToolDefinition |
As informações de definição de entrada para uma ferramenta de interpretador de código usada para configurar um assistente. |
| CreateAndRunThreadOptions |
Os detalhes usados ao criar e executar imediatamente um novo thread do 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 do 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 do assistente. |
| DeleteAssistantOptions |
Os detalhes usados para excluir um assistente. |
| DeleteFileOptions |
Os detalhes usados para excluir arquivos. |
| DeleteThreadOptions |
Os detalhes usados para excluir um tópico. |
| DeletionStatus |
Uma representação abstrata de um status de resultado de operação de exclusão do OpenAI. |
| FileDeletionStatus |
Uma resposta de 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 usada para configurar um assistente. |
| GetAssistantFileOptions |
Os detalhes usados para obter um arquivo assistente. |
| GetAssistantOptions |
Os detalhes usados para obter um 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 corrida. |
| GetRunStepOptions |
Os detalhes usados para obter uma etapa de execução. |
| GetThreadOptions |
Os detalhes usados para obter um tópico. |
| InputFile |
Representa um assistente que pode chamar o modelo e usar ferramentas. |
| ListAssistantFilesOptions |
Os detalhes usados para listar os arquivos do assistente. |
| ListAssistantsOptions |
Os detalhes usados para listar assistentes. |
| ListFilesOptions |
Os detalhes usados para listar arquivos. |
| ListMessageFilesOptions |
Os detalhes usados para listar arquivos de mensagens. |
| 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 do 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 do conteúdo da mensagem do thread do assistente. |
| 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 do assistente continue. |
| RequiredFunctionToolCall |
Uma representação de uma chamada solicitada para uma ferramenta de função, necessária pelo modelo para continuar a avaliação de uma execução. |
| RetrievalToolCall |
Um registro de uma chamada para uma ferramenta de recuperação, emitida pelo modelo na avaliação de uma ferramenta definida, que representa ações de recuperação executadas. |
| RetrievalToolDefinition |
As informações de definição de entrada para uma ferramenta de recuperação usada para configurar um assistente. |
| RunError |
Os detalhes de um erro encontrados por um thread assistente são executados. |
| RunStep |
Informações detalhadas sobre uma única etapa de uma execução de thread do 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 de ferramentas de chamada. |
| 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 do assistente. |
| ThreadRun |
Dados que representam uma única execução de avaliação de um thread do assistente. |
| ToolOutput |
Os dados fornecidos durante um envio de saídas de ferramenta para resolver chamadas de ferramenta pendentes e permitir 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 corrida. |
| UpdateThreadOptions |
Os detalhes usados para atualizar um thread. |
| UploadFileOptions |
Os detalhes usados para fazer upload de arquivos. |
Aliases de tipo
| CodeInterpreterToolCallOutput |
Alias para CodeInterpreterToolCallOutput |
| FilePurpose |
"ajuste fino", "ajuste fino dos resultados", "assistentes", "assistants_output" |
| ListSortOrder |
"asc", "desc" |
| MessageContent |
Alias para MessageContent |
| MessageRole |
"usuário", "assistente" |
| MessageTextAnnotation |
Alias para MessageTextAnnotation |
| RequiredToolCall |
Alias para RequiredToolCall |
| RunStatus |
"em fila", "in_progress", "requires_action", "cancelando", "cancelado", "falhou", "concluído", "expirou" |
| RunStepDetails |
Alias para RunStepDetails |
| RunStepErrorCode |
"server_error", "rate_limit_exceeded" |
| RunStepStatus |
"in_progress", "cancelado", "reprovado", "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. |
