Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack šŸŽ‰ Learn more
LibreChat

Estrutura do Objeto do endpoint Assistants

Esta pƔgina se aplica a ambos os endpoints assistants e azureAssistants.

Nota: Para habilitar azureAssistants, consulte a Configuração do Azure OpenAI para mais informações.

Exemplo

endpoints:
  # azureAssistants: # <-- Azure-specific configuration has the same structure as `assistants`
    #  pollIntervalMs: 500
    #  timeoutMs: 10000

  assistants:
    disableBuilder: false
    # Use either `supportedIds` or `excludedIds` but not both
    supportedIds: ["asst_supportedAssistantId1", "asst_supportedAssistantId2"]
    # excludedIds: ["asst_excludedAssistantId"]
    # `privateAssistants` do not work with `supportedIds` or `excludedIds`
    # privateAssistants: false
    # (optional) Models that support retrieval, will default to latest known OpenAI models that support the feature
    # retrievalModels: ["gpt-4-turbo-preview"]
    # (optional) Assistant Capabilities available to all users. Omit the ones you wish to exclude. Defaults to list below.
    # capabilities: ["code_interpreter", "retrieval", "actions", "tools", "image_vision"]

Esta configuração habilita a interface do construtor para assistentes, define um intervalo de polling de 500ms para verificar atualizações de execução e estabelece um tempo limite de 10 segundos para operações de execução do assistente.

disableBuilder

Chave:

KeyTypeDescriptionExample
disableBuilderBooleanControla a visibilidade e o uso da interface do construtor para assistentes.When set to `true`, disables the builder interface for the assistant, limiting direct manual interaction.

Padrão: false

Exemplo:

disableBuilder: false

pollIntervalMs

Chave:

KeyTypeDescriptionExample
pollIntervalMsIntegerEspecifica o intervalo de polling em milissegundos para verificar atualizações de execução ou alterações nos estados de execução do assistente.Specifies the polling interval in milliseconds for checking assistant run updates.

Padrão: 2000

Exemplo:

pollIntervalMs: 2500

Nota: Atualmente, isso é usado apenas por Azure Assistants. Valores mais altos são recomendados para Azure Assistants para evitar erros de limite de taxa (rate limiting).

timeoutMs

Chave:

KeyTypeDescriptionExample
timeoutMsIntegerDefine o tempo mÔximo em milissegundos que um assistente pode executar antes que a solicitação seja cancelada.Sets a timeout in milliseconds for assistant runs. Helps manage system load by limiting total run operation time.

Padrão: 180000

Exemplo:

timeoutMs: 10000

Nota: O padrão é de 3 minutos (180.000 ms). Os tempos de execução da operação podem variar entre 50 segundos a 2 minutos, mas também podem exceder esse valor. Se o valor de timeoutMs for excedido, a execução serÔ cancelada.

supportedIds

Chave:

KeyTypeDescriptionExample
supportedIdsArray/List of StringsLista de IDs de assistentes suportadosUse this or `excludedIds` but not both (the `excludedIds` field will be ignored if so).

Exemplo:

supportedIds:
  - "asst_supportedAssistantId1"
  - "asst_supportedAssistantId2"

excludedIds

Chave:

KeyTypeDescriptionExample
excludedIdsArray/List of StringsLista de IDs de assistentes excluĆ­dosUse this or `supportedIds` but not both (the `excludedIds` field will be ignored if so).

Exemplo:

excludedIds:
  - "asst_excludedAssistantId1"
  - "asst_excludedAssistantId2"

privateAssistants

Chave:

KeyTypeDescriptionExample
privateAssistantsBooleanControla se os assistentes são privados para o usuÔrio que os criouDoes not work with `supportedIds` or `excludedIds` (`supportedIds` and `excludedIds` will be ignored).

Padrão: false

Exemplo:

privateAssistants: false

retrievalModels

Chave:

KeyTypeDescriptionExample
retrievalModelsArray/List of StringsEspecifica os modelos que suportam recuperação para o endpoint de assistentes.Defines the models that support retrieval capabilities for the assistants endpoint. By default, it uses the latest known OpenAI models that support the official Retrieval feature.

Padrão: [] (usa os modelos mais recentes conhecidos da OpenAI que suportam retrieval)

Exemplo:

retrievalModels:
  - "gpt-4-turbo-preview"

capabilities

Chave:

KeyTypeDescriptionExample
capabilitiesArray/List of StringsEspecifica as capacidades do assistente disponƭveis para todos os usuƔrios para o endpoint assistants.Defines the assistant capabilities that are available to all users for the assistants endpoint. You can omit the capabilities you wish to exclude from the list.

Padrão: ["code_interpreter", "image_vision", "retrieval", "actions", "tools"]

Exemplo:

capabilities:
  - "code_interpreter"
  - "retrieval"
  - "actions"
  - "tools"
  - "image_vision"

Nota: Este campo é opcional. Se omitido, o comportamento padrão é incluir todos os recursos listados no exemplo.

Como estĆ” este guia?