Compartilhar via

Assistentes do OpenAI (Editor Independente) (versão prévia)

Os Assistentes do OpenAI permitem que você crie assistentes de IA em seus próprios aplicativos. Um Assistente tem instruções e pode aproveitar modelos, ferramentas e conhecimento para responder a consultas de usuário. Atualmente, o serviço Assistentes dá suporte a três tipos de ferramentas: Interpretação de Código, Recuperação e Chamada de Função.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadados do conector
Publicador Troy Taylor
Site https://openai.com/
Política de privacidade https://openai.com/policies/privacy-policy
Categorias IA

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:
Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave de API (no formato 'Portador $OPENAI_API_KEY') secureString A chave de API (no formato 'Bearer $OPENAI_API_KEY') para esta api Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Acessar thread

Recuperar um thread.
Assistente de recuperação

Recupera informações sobre um assistente.
Cancelar uma execução

Cancele uma execução para um thread que está em andamento.
Criar arquivo de assistente

Crie um arquivo de assistente anexando um arquivo a um assistente.
Criar assistente

Crie um assistente com um modelo e instruções.
Criar execução

Cria uma execução para um thread.
Criar mensagem

Crie uma mensagem dentro de um thread.
Criar thread

Cria um thread com o qual os assistentes podem interagir.
Criar thread e executar

Cria um thread e o executa em uma solicitação.
Enviar saídas de ferramenta para execução

Quando uma execução tem o status: "requires_action" e required_action.type é submit_tool_outputs, essa ação pode ser usada para enviar as saídas das chamadas de ferramenta quando todas elas forem concluídas.
Etapas de execução de lista

Recupere uma lista de etapas de execução para um thread.
Excluir arquivo do assistente

Exclui um arquivo de assistente.
Excluir assistente

Exclui um assistente.
Excluir thread

Exclui um thread.
Execuções de lista

Recupere uma lista de execuções para um thread.
Listar arquivos de mensagem

Recupera uma lista de arquivos de mensagem para um thread.
Listar assistentes

Recupera uma lista de assistentes.
Listar mensagens

Recupere uma lista de mensagens para um determinado thread.
Listar modelos

Lista os modelos disponíveis no momento e fornece informações básicas sobre cada um deles, como o proprietário e a disponibilidade.
Modificar execução

Modifica uma execução para um thread.
Modificar mensagem

Modifica uma mensagem.
Modificar um thread

Modifica um thread.
Obter a etapa de execução

Recupere uma etapa de execução para um thread.
Obter arquivos de assistente

Recupera uma lista de arquivos de assistente.
Obter execução

Recuperar uma execução de um thread.
Recuperar arquivo de mensagem

Recupera um arquivo de mensagem de um thread.
Recuperar arquivo do assistente

Recupera um arquivo de assistente.

Acessar thread

ID da operação:
ThreadGet

Recuperar um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.

Assistente de recuperação

ID da operação:
AssistantGet

Recupera informações sobre um assistente.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
ID do assistente
 assistant_id True string

O identificador do assistente.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
Nome
 name string

O nome.
Description
 description string

A descrição.
Modelo
 model string

O modelo.
Instruções
 instructions string

As instruções.
Tools
 tools array of object
Tipo
 tools.type string

O tipo de ferramentas.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.

Cancelar uma execução

ID da operação:
RunCancelPost

Cancele uma execução para um thread que está em andamento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
Executar ID
 run_id True string

O identificador de execução.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
ID do assistente
 assistant_id string

O identificador do assistente.
Thread ID
 thread_id string

O identificador de thread.
Situação
 status string

O status.
Iniciado em
 started_at integer

Quando começou.
Expira em
 expires_at integer

Quando expirar em.
Cancelado em
 cancelled_at string

Quando cancelado em.
Falha em
 failed_at string

Quando falhou.
Concluído em
 completed_at string

Quando concluído em.
Último Erro
 last_error string

O último erro.
Modelo
 model string

O modelo.
Instruções
 instructions string

As instruções.
Tools
 tools array of object
Tipo
 tools.type string

O tipo de ferramentas.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.

Criar arquivo de assistente

ID da operação:
FilePost

Crie um arquivo de assistente anexando um arquivo a um assistente.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
ID do assistente
 assistant_id True string

O identificador do assistente.
ID de Arquivo
 file_id True string

O identificador de arquivo.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
ID do assistente
 assistant_id string

O identificador do assistente.

Criar assistente

ID da operação:
AssistantPost

Crie um assistente com um modelo e instruções.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Modelo
 model True string

O modelo.
Instruções
 instructions string

As instruções.
Nome
 name string

O nome.
Description
 description string

A descrição.
Tipo
 type string

O tipo de ferramentas.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
Nome
 name string

O nome.
Description
 description string

A descrição.
Modelo
 model string

O modelo.
Instruções
 instructions string

As instruções.
Tools
 tools array of object
Tipo
 tools.type string

O tipo de ferramenta.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.

Criar execução

ID da operação:
RunPost

Cria uma execução para um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
ID do assistente
 assistant_id string

O identificador do assistente.
Modelo
 model True string

O modelo.
Instruções
 instructions string

As instruções.
Tipo
 type string

O tipo de ferramentas.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
ID do assistente
 assistant_id string

O identificador do assistente.
Thread ID
 thread_id string

O identificador de thread.
Situação
 status string

O status.
Iniciado em
 started_at integer

Quando começou.
Expira em
 expires_at string

Quando expirar em.
Cancelado em
 cancelled_at string

Quando cancelado em.
Falha em
 failed_at string

Quando falhou.
Concluído em
 completed_at integer

Quando concluído em.
Último Erro
 last_error string

O último erro.
Modelo
 model string

O modelo.
Instruções
 instructions string

As instruções.
Tools
 tools array of object
Tipo
 tools.type string

O tipo de ferramentas.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.

Criar mensagem

ID da operação:
MessagePost

Crie uma mensagem dentro de um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
Thread ID
 thread_id string

O identificador de thread.
Função
 role string

A função.
Content
 content array of object
Tipo
 content.type string

O tipo de ferramentas.
Value
 content.text.value string

O valor.
Annotations
 content.text.annotations array of string

As anotações.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.
ID do assistente
 assistant_id string

O identificador do assistente.
Executar ID
 run_id string

O identificador de execução.

Criar thread

ID da operação:
ThreadPost

Cria um thread com o qual os assistentes podem interagir.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
Thread ID
 thread_id string

O identificador de thread.
Função
 role True string

A função.
Content
 content True string

O conteúdo.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.
ID do assistente
 assistant_id string

O identificador do assistente.
Executar ID
 run_id string

O identificador de execução.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.

Criar thread e executar

ID da operação:
ThreadRunPost

Cria um thread e o executa em uma solicitação.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
ID do assistente
 assistant_id string

O identificador do assistente.
Função
 role string

A função.
Content
 content string

O conteúdo.
Modelo
 model string

O modelo.
Instruções
 instructions string

As instruções.
Tipo
 type string

O tipo de ferramentas.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
ID do assistente
 assistant_id string

O identificador do assistente.
Thread ID
 thread_id string

O identificador de thread.
Situação
 status string

O status.
Iniciado em
 started_at string

Quando começou.
Expira em
 expires_at integer

Quando expirar em.
Cancelado em
 cancelled_at string

Quando cancelado em.
Falha em
 failed_at string

Quando falhou.
Concluído em
 completed_at string

Quando concluído em.
Último Erro
 last_error string

O último erro.
Modelo
 model string

O modelo.
Instruções
 instructions string

As instruções.
Tools
 tools array of object
Tipo
 tools.type string

O tipo de ferramentas.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.

Enviar saídas de ferramenta para execução

ID da operação:
RunToolOutputsPost

Quando uma execução tem o status: "requires_action" e required_action.type é submit_tool_outputs, essa ação pode ser usada para enviar as saídas das chamadas de ferramenta quando todas elas forem concluídas.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
Executar ID
 run_id True string

O identificador de execução.
ID da chamada da ferramenta
 tool_call_id string

O identificador de chamada de pedágio.
Saída
 output string

A saída.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
ID do assistente
 assistant_id string

O identificador do assistente.
Thread ID
 thread_id string

O identificador de thread.
Situação
 status string

O status.
Iniciado em
 started_at integer

Quando começou.
Expira em
 expires_at integer

Quando expirar em.
Cancelado em
 cancelled_at string

Quando cancelado em.
Falha em
 failed_at string

Quando falhou.
Concluído em
 completed_at string

Quando concluído em.
Último Erro
 last_error string

O último erro.
Modelo
 model string

O modelo.
Instruções
 instructions string

As instruções.
Tools
 tools array of object
Tipo
 tools.type string

O tipo de ferramentas.
Nome
 tools.function.name string

O nome.
Description
 tools.function.description string

A descrição.
Tipo
 tools.function.parameters.type string

O tipo.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.

Etapas de execução de lista

ID da operação:
RunStepsGet

Recupere uma lista de etapas de execução para um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
Executar ID
 run_id True string

O identificador de execução.
Limit
 limit integer

O limite.
Pedido
 order string

A ordem.
Após
 after string

O depois.
Antes
 before string

O anterior.

Retornos

Nome Caminho Tipo Description
Object
 object string

O objeto.
Dados
 data array of object
ID
 data.id string

O identificador.
Object
 data.object string

O objeto.
Criado em
 data.created_at integer

Quando criado em.
Executar ID
 data.run_id string

O identificador de execução.
ID do assistente
 data.assistant_id string

O identificador do assistente.
Thread ID
 data.thread_id string

O identificador de thread.
Tipo
 data.type string

O tipo de ferramentas.
Situação
 data.status string

O status.
Cancelado em
 data.cancelled_at string

Quando cancelado em.
Concluído em
 data.completed_at integer

Quando concluído em.
Expirado em
 data.expired_at string

Quando expirou em.
Falha em
 data.failed_at string

Quando falhou.
Último Erro
 data.last_error string

O último erro.
Tipo
 data.step_details.type string

O tipo.
ID da mensagem
 data.step_details.message_creation.message_id string

O identificador da mensagem.
Primeira ID
 first_id string

O primeiro identificador.
Última ID
 last_id string

O último identificador.
Tem mais
 has_more boolean

Se tem mais.

Excluir arquivo do assistente

ID da operação:
FileDelete

Exclui um arquivo de assistente.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
ID do assistente
 assistant_id True string

O identificador do assistente.
ID de Arquivo
 file_id True string

O identificador de arquivo.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Excluído(a)
 deleted boolean

Se excluído.

Excluir assistente

ID da operação:
AssistantDelete

Exclui um assistente.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
ID do assistente
 assistant_id True string

O identificador do assistente.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Excluído(a)
 deleted boolean

Se excluído.

Excluir thread

ID da operação:
ThreadDelete

Exclui um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Excluído(a)
 deleted boolean

Se excluído.

Execuções de lista

ID da operação:
RunsGet

Recupere uma lista de execuções para um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
Limit
 limit integer

O limite.
Pedido
 order string

A ordem.
Após
 after string

O depois.
Antes
 before string

O anterior.

Retornos

Nome Caminho Tipo Description
Object
 object string

O objeto.
Dados
 data array of object
ID
 data.id string

O identificador.
Object
 data.object string

O objeto.
Criado em
 data.created_at integer

Quando criado em.
ID do assistente
 data.assistant_id string

O identificador do assistente.
Thread ID
 data.thread_id string

O identificador de thread.
Situação
 data.status string

O status.
Iniciado em
 data.started_at integer

Quando começou.
Expira em
 data.expires_at string

Quando expirar em.
Cancelado em
 data.cancelled_at string

Quando cancelado em.
Falha em
 data.failed_at string

Quando falhou.
Concluído em
 data.completed_at integer

Quando concluído em.
Último Erro
 data.last_error string

O último erro.
Modelo
 data.model string

O modelo.
Instruções
 data.instructions string

As instruções.
Tools
 data.tools array of object
Tipo
 data.tools.type string

O tipo.
IDs de arquivo
 data.file_ids array of string

Os identificadores de arquivo.
Primeira ID
 first_id string

O primeiro identificador.
Última ID
 last_id string

O último identificador.
Tem mais
 has_more boolean

Se tem mais.

Listar arquivos de mensagem

ID da operação:
MessageFilesGet

Recupera uma lista de arquivos de mensagem para um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
ID da mensagem
 message_id True string

O identificador da mensagem.

Retornos

Nome Caminho Tipo Description
Object
 object string

O objeto.
Dados
 data array of object
ID
 data.id string

O identificador.
Object
 data.object string

O objeto.
Criado em
 data.created_at integer

Quando criado em.
ID da mensagem
 data.message_id string

O identificador da mensagem.
Primeira ID
 first_id string

O primeiro identificador.
Última ID
 last_id string

O último identificador.
Tem mais
 has_more boolean

Se tem mais.

Listar assistentes

ID da operação:
AssistantsGet

Recupera uma lista de assistentes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.

Retornos

Nome Caminho Tipo Description
Object
 object string

O objeto.
Dados
 data array of object
ID
 data.id string

O identificador.
Object
 data.object string

O objeto.
Criado em
 data.created_at integer

Quando criado em.
Nome
 data.name string

O nome.
Description
 data.description string

A descrição.
Modelo
 data.model string

O modelo.
Instruções
 data.instructions string

As instruções.
Tools
 data.tools array of object
Tipo
 data.tools.type string

O tipo.
IDs de arquivo
 data.file_ids array of string

Os identificadores de arquivo.
Primeira ID
 first_id string

O primeiro identificador.
Última ID
 last_id string

O último identificador.
Tem mais
 has_more boolean

Se tem mais.

Listar mensagens

ID da operação:
MessagesGet

Recupere uma lista de mensagens para um determinado thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
Limit
 limit integer

O limite.
Pedido
 order string

A ordem.
Após
 after string

O depois.
Antes
 before string

O anterior.

Retornos

Nome Caminho Tipo Description
Object
 object string

O objeto.
Dados
 data array of object
ID
 data.id string

O identificador.
Object
 data.object string

O objeto.
Criado em
 data.created_at integer

Quando criado em.
Thread ID
 data.thread_id string

O identificador de thread.
Função
 data.role string

A função.
Content
 data.content array of object
Tipo
 data.content.type string

O tipo.
Value
 data.content.text.value string

O valor.
Annotations
 data.content.text.annotations array of string

As anotações.
IDs de arquivo
 data.file_ids array of string

Os identificadores de arquivo.
ID do assistente
 data.assistant_id string

O identificador do assistente.
Executar ID
 data.run_id string

O identificador de execução.
Primeira ID
 first_id string

O primeiro identificador.
Última ID
 last_id string

O último identificador.
Tem mais
 has_more boolean

Se tem mais.

Listar modelos

ID da operação:
ModelsGet

Lista os modelos disponíveis no momento e fornece informações básicas sobre cada um deles, como o proprietário e a disponibilidade.

Retornos

Nome Caminho Tipo Description
Object
 object string

O objeto.
Dados
 data array of object
ID
 data.id string

O identificador.
Object
 data.object string

O objeto.
Criado
 data.created integer

Quando criado.
Propriedade por
 data.owned_by string

De propriedade.

Modificar execução

ID da operação:
RunModifyPost

Modifica uma execução para um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
Executar ID
 run_id True string

O identificador de execução.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
ID do assistente
 assistant_id string

O identificador do assistente.
Thread ID
 thread_id string

O identificador de thread.
Situação
 status string

O status.
Iniciado em
 started_at integer

Quando começou.
Expira em
 expires_at string

Quando expirar em.
Cancelado em
 cancelled_at string

Quando cancelado em.
Falha em
 failed_at string

Quando falhou.
Concluído em
 completed_at integer

Quando concluído em.
Último Erro
 last_error string

O último erro.
Modelo
 model string

O modelo.
Instruções
 instructions string

As instruções.
Tools
 tools array of object
Tipo
 tools.type string

O tipo de ferramentas.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.

Modificar mensagem

ID da operação:
MessageModifyPost

Modifica uma mensagem.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
ID da mensagem
 message_id True string

O identificador da mensagem.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
Thread ID
 thread_id string

O identificador de thread.
Função
 role string

A função.
Content
 content array of object
Tipo
 content.type string

O tipo de ferramentas.
Value
 content.text.value string

O valor.
Annotations
 content.text.annotations array of string

As anotações.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.
ID do assistente
 assistant_id string

O identificador do assistente.
Executar ID
 run_id string

O identificador de execução.

Modificar um thread

ID da operação:
ThreadModifyPost

Modifica um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.

Obter a etapa de execução

ID da operação:
RunStepGet

Recupere uma etapa de execução para um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
Executar ID
 run_id True string

O identificador de execução.
ID da etapa
 step_id True string

O identificador da etapa.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
Executar ID
 run_id string

O identificador de execução.
ID do assistente
 assistant_id string

O identificador do assistente.
Thread ID
 thread_id string

O identificador de thread.
Tipo
 type string

O tipo.
Situação
 status string

O status.
Cancelado em
 cancelled_at string

Quando cancelado em.
Concluído em
 completed_at integer

Quando concluído em.
Expirado em
 expired_at string

Quando expirou em.
Falha em
 failed_at string

Quando falhou.
Último Erro
 last_error string

O último erro.
Tipo
 step_details.type string

O tipo.
ID da mensagem
 step_details.message_creation.message_id string

O identificador da mensagem.

Obter arquivos de assistente

ID da operação:
FilesGet

Recupera uma lista de arquivos de assistente.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
ID do assistente
 assistant_id True string

O identificador do assistente.

Retornos

Nome Caminho Tipo Description
Object
 object string

O objeto.
Dados
 data array of object
ID
 data.id string

O identificador.
Object
 data.object string

O objeto.
Criado em
 data.created_at integer

Quando criado em.
ID do assistente
 data.assistant_id string

O identificador do assistente.
Primeira ID
 first_id string

O primeiro identificador.
Última ID
 last_id string

O último identificador.
Tem mais
 has_more boolean

Se tem mais.

Obter execução

ID da operação:
RunGet

Recuperar uma execução de um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
Executar ID
 run_id True string

O identificador de execução.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
ID do assistente
 assistant_id string

O identificador do assistente.
Thread ID
 thread_id string

O identificador de thread.
Situação
 status string

O status.
Iniciado em
 started_at integer

Quando começou.
Expira em
 expires_at string

Quando expirar em.
Cancelado em
 cancelled_at string

Quando cancelado em.
Falha em
 failed_at string

Quando falhou.
Concluído em
 completed_at integer

Quando concluído em.
Último Erro
 last_error string

O último erro.
Modelo
 model string

O modelo.
Instruções
 instructions string

As instruções.
Tools
 tools array of object
Tipo
 tools.type string

O tipo de ferramentas.
IDs de arquivo
 file_ids array of string

Os identificadores de arquivo.

Recuperar arquivo de mensagem

ID da operação:
MessageFileGet

Recupera um arquivo de mensagem de um thread.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
Thread ID
 thread_id True string

O identificador de thread.
ID da mensagem
 message_id True string

O identificador da mensagem.
ID de Arquivo
 file_id True string

O identificador de arquivo.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
ID da mensagem
 message_id string

O identificador da mensagem.

Recuperar arquivo do assistente

ID da operação:
FileGet

Recupera um arquivo de assistente.

Parâmetros

Nome Chave Obrigatório Tipo Description
Cabeçalho Beta
 OpenAI-Beta True string

O cabeçalho beta. Necessário para ser definido enquanto a API está em beta.
ID do assistente
 assistant_id True string

O identificador do assistente.
ID de Arquivo
 file_id True string

O identificador de arquivo.

Retornos

Nome Caminho Tipo Description
ID
 id string

O identificador.
Object
 object string

O objeto.
Criado em
 created_at integer

Quando criado em.
ID do assistente
 assistant_id string

O identificador do assistente.