@azure/openai-assistants package

Classes

AssistantsClient	Processamento de clientes assistente operações relacionadas com o .
AzureKeyCredential	Uma credencial baseada em chave estática que suporta a atualização do valor da chave subjacente.
OpenAIKeyCredential	A classe OpenAIKeyCredential representa uma chave da API OpenAI e é utilizada para se autenticar num cliente de Assistentes para um ponto final OpenAI.

Interfaces

Assistant	Representa uma assistente que pode chamar o modelo e utilizar ferramentas.
AssistantCreationOptions	Os detalhes do pedido a utilizar ao criar um novo assistente.
AssistantDeletionStatus	O estado de uma operação de eliminação de assistente.
AssistantFile	Informações sobre um ficheiro anexado a um assistente, conforme utilizado pelas ferramentas que podem ler ficheiros.
AssistantFileDeletionStatus	O estado de uma operação de eliminação de ficheiros assistente.
AssistantThread	Informações sobre um único thread associado a um assistente.
AssistantThreadCreationOptions	Os detalhes utilizados para criar um novo tópico de assistente.
AssistantsClientOptions	Os detalhes utilizados para criar um cliente assistente *
CancelRunOptions	Os detalhes utilizados para cancelar uma execução.
CodeInterpreterImageOutput	Uma representação de uma saída de imagem emitida por uma ferramenta de intérprete de código em resposta a uma chamada de ferramenta pelo modelo.
CodeInterpreterImageReference	Uma referência de imagem emitida por uma ferramenta de intérprete de código em resposta a uma chamada de ferramenta pelo modelo.
CodeInterpreterLogOutput	Uma representação de uma saída de registo emitida por uma ferramenta de intérprete de código em resposta a uma chamada de ferramenta pelo modelo.
CodeInterpreterToolCall	Um registo de uma chamada para uma ferramenta de intérprete de código, emitida 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 a invocação de um intérprete de código pelo modelo.
CodeInterpreterToolDefinition	As informações de definição de entrada de uma ferramenta de intérprete de código, conforme utilizado para configurar um assistente.
CreateAndRunThreadOptions	Os detalhes utilizados ao criar e executar imediatamente um novo thread de assistente.
CreateAssistantFileOptions	Os detalhes utilizados para criar um ficheiro assistente.
CreateAssistantOptions	Os detalhes utilizados para criar um assistente.
CreateMessageOptions	Os detalhes utilizados para criar uma mensagem.
CreateRunOptions	Os detalhes utilizados ao criar uma nova execução de um thread de assistente.
CreateRunRequestOptions	Os detalhes utilizados para criar um pedido de execução.
CreateThreadAndRunOptions	Os detalhes utilizados para criar e executar um thread.
CreateThreadOptions	Os detalhes utilizados para criar um thread.
DeleteAssistantFileOptions	Os detalhes utilizados para eliminar um ficheiro assistente.
DeleteAssistantOptions	Os detalhes utilizados para eliminar um assistente.
DeleteFileOptions	Os detalhes utilizados para eliminar ficheiros.
DeleteThreadOptions	Os detalhes utilizados para eliminar um thread.
DeletionStatus	Uma representação abstrata do estado do resultado de uma operação de eliminação OpenAI.
FileDeletionStatus	Uma resposta de estado de uma operação de eliminação de ficheiros.
FileListResponse	Os dados de resposta de uma operação de lista de ficheiros.
FunctionDefinition	As informações de definição de entrada de uma função.
FunctionToolCall	Um registo de uma chamada para uma ferramenta de função, emitido pelo modelo na avaliação de uma ferramenta definida, que representa as entradas e 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 de uma ferramenta de função, conforme utilizado para configurar um assistente.
GetAssistantFileOptions	Os detalhes utilizados para obter um ficheiro de assistente.
GetAssistantOptions	Os detalhes utilizados para obter uma assistente.
GetFileOptions	Os detalhes utilizados para obter ficheiros.
GetMessageFileOptions	Os detalhes utilizados para obter um ficheiro de mensagem.
GetMessageOptions	Os detalhes utilizados para obter uma mensagem.
GetRunOptions	Os detalhes utilizados para obter uma execução.
GetRunStepOptions	Os detalhes utilizados para obter um passo de execução.
GetThreadOptions	Os detalhes utilizados para obter um thread.
InputFile	Representa uma assistente que pode chamar o modelo e utilizar ferramentas.
ListAssistantFilesOptions	Os detalhes utilizados para listar assistente ficheiros.
ListAssistantsOptions	Os detalhes utilizados para listar assistentes.
ListFilesOptions	Os detalhes utilizados para listar ficheiros.
ListMessageFilesOptions	Os detalhes utilizados para listar ficheiros de mensagens.
ListMessagesOptions	Os detalhes utilizados para listar mensagens.
ListResponseOf	Os dados de resposta de uma lista de itens pedida.
ListRunStepsOptions	Os detalhes utilizados para listar passos de execução.
ListRunsOptions	Os detalhes utilizados para listar execuções.
MessageFile	Informações sobre um ficheiro anexado a uma mensagem de tópico assistente.
MessageImageFileContent	Uma representação do conteúdo do ficheiro de imagem numa mensagem de thread.
MessageImageFileDetails	Uma referência de imagem, representada no conteúdo da mensagem de tópico.
MessageTextContent	Uma representação de um item textual de conteúdo de mensagens de thread.
MessageTextDetails	O texto e as anotações associadas para um único item de assistente conteúdo da mensagem de tópico.
MessageTextFileCitationAnnotation	Uma citação na mensagem que aponta para uma citação específica de um Ficheiro específico associado ao assistente ou à mensagem. Gerado quando o assistente utiliza a ferramenta de "obtenção" para procurar ficheiros.
MessageTextFileCitationDetails	Uma representação de uma citação de texto baseada em ficheiros, conforme utilizado numa anotação baseada em ficheiros de conteúdo de mensagens de thread de texto.
MessageTextFilePathAnnotation	Uma citação na mensagem que aponta para um ficheiro localizado num caminho específico.
MessageTextFilePathDetails	Encapsulamento de um ID de ficheiro de imagem, conforme utilizado pelo conteúdo da imagem da mensagem.
RequiredAction	Uma representação abstrata de uma ação necessária para uma execução de thread assistente continuar.
RequiredFunctionToolCall	Uma representação de uma chamada pedida para uma ferramenta de função, necessária pelo modelo para continuar a avaliação de uma execução.
RetrievalToolCall	Um registo de uma chamada para uma ferramenta de obtenção, emitida pelo modelo na avaliação de uma ferramenta definida, que representa ações de obtenção executadas.
RetrievalToolDefinition	As informações de definição de entrada para uma ferramenta de obtenção, conforme utilizado para configurar um assistente.
RunError	Os detalhes de um erro, conforme encontrado por uma execução de thread assistente.
RunStep	Informações detalhadas sobre um único passo de uma execução de thread assistente.
RunStepError	As informações de erro associadas a um passo de execução falhado.
RunStepMessageCreationDetails	As informações detalhadas associadas a um passo de execução de criação de mensagens.
RunStepMessageCreationReference	Os detalhes de uma mensagem criada como parte de um passo de execução.
RunStepToolCallDetails	As informações detalhadas associadas a ferramentas de chamadas de passos de execução.
SubmitToolOutputsDetails	Os detalhes que descrevem as ferramentas que devem ser chamadas para submeter saídas de ferramentas.
SubmitToolOutputsToRunOptions	Os detalhes utilizados para submeter saídas de ferramentas para uma execução.
ThreadDeletionStatus	O estado de uma operação de eliminação de threads.
ThreadMessage	Uma única mensagem existente num tópico de assistente.
ThreadRun	Dados que representam uma única execução de avaliação de um thread de assistente.
ToolOutput	Os dados fornecidos durante a submissão de saídas de ferramentas para resolver chamadas de ferramentas pendentes e permitir que o modelo continue.
UpdateAssistantOptions	Os detalhes do pedido a utilizar ao modificar uma assistente existente.
UpdateAssistantRequestOptions	Os detalhes utilizados para atualizar uma assistente.
UpdateMessageOptions	Os detalhes utilizados para atualizar uma mensagem.
UpdateRunOptions	Os detalhes utilizados para atualizar uma execução.
UpdateThreadOptions	Os detalhes utilizados para atualizar um thread.
UploadFileOptions	Os detalhes utilizados para carregar ficheiros.

Aliases de Tipo

CodeInterpreterToolCallOutput	Alias for CodeInterpreterToolCallOutput
FilePurpose	"fine-tune", "fine-tune-results", "assistants", "assistants_output"
ListSortOrder	"asc", "desc"
MessageContent	Alias para MessageContent
MessageRole	"utilizador", "assistente"
MessageTextAnnotation	Alias for MessageTextAnnotation
RequiredToolCall	Alias for RequiredToolCall
RunStatus	"em fila", "in_progress", "requires_action", "canceling", "cancelled", "failed", "completed", "expired"
RunStepDetails	Alias for RunStepDetails
RunStepErrorCode	"server_error", "rate_limit_exceeded"
RunStepStatus	"in_progress", "cancelou", "falhou", "concluído", "expirou"
RunStepType	"message_creation", "tool_calls"
ToolCall	Alias for ToolCall
ToolDefinition	Uma representação abstrata de uma definição de ferramenta de entrada que um assistente pode utilizar.