Assistants Endpoint 객체 구조

이 페이지는 assistants 및 azureAssistants endpoint 모두에 적용됩니다.

참고: azureAssistants를 활성화하려면 Azure OpenAI Configuration에서 자세한 내용을 확인하세요.

예시

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"]

이 구성은 어시스턴트를 위한 빌더 인터페이스를 활성화하고, 실행 업데이트를 확인하기 위한 폴링 간격을 500ms로 설정하며, 어시스턴트 실행 작업에 대해 10초의 타임아웃을 설정합니다.

disableBuilder

키:

Key	Type	Description	Example
disableBuilder	Boolean	어시스턴트용 빌더 인터페이스의 표시 여부와 사용을 제어합니다.	When set to `true`, disables the builder interface for the assistant, limiting direct manual interaction.

기본값: false

예시:

disableBuilder: false

pollIntervalMs

키:

Key	Type	Description	Example
pollIntervalMs	Integer	어시스턴트 실행 상태의 업데이트나 변경 사항을 확인하기 위한 폴링 간격을 밀리초 단위로 지정합니다.	Specifies the polling interval in milliseconds for checking assistant run updates.

기본값: 2000

예시:

pollIntervalMs: 2500

참고: 현재 이 설정은 Azure Assistants에서만 사용됩니다. Azure Assistants의 경우 속도 제한 오류를 방지하기 위해 더 높은 값을 사용하는 것이 좋습니다.

timeoutMs

키:

Key	Type	Description	Example
timeoutMs	Integer	어시스턴트가 실행될 수 있는 최대 시간을 밀리초 단위로 정의하며, 이 시간이 지나면 요청이 취소됩니다.	Sets a timeout in milliseconds for assistant runs. Helps manage system load by limiting total run operation time.

기본값: 180000

예시:

timeoutMs: 10000

참고: 기본값은 3분(180,000ms)입니다. 실행 작업 시간은 50초에서 2분 사이일 수 있지만, 이를 초과할 수도 있습니다. timeoutMs 값을 초과하면 실행이 취소됩니다.

supportedIds

키:

Key	Type	Description	Example
supportedIds	Array/List of Strings	지원되는 assistant Id 목록	Use this or `excludedIds` but not both (the `excludedIds` field will be ignored if so).

예시:

supportedIds:
  - "asst_supportedAssistantId1"
  - "asst_supportedAssistantId2"

excludedIds

키:

Key	Type	Description	Example
excludedIds	Array/List of Strings	제외된 assistant ID 목록	Use this or `supportedIds` but not both (the `excludedIds` field will be ignored if so).

예시:

excludedIds:
  - "asst_excludedAssistantId1"
  - "asst_excludedAssistantId2"

privateAssistants

키:

Key	Type	Description	Example
privateAssistants	Boolean	어시스턴트를 생성한 사용자만 비공개로 사용할 수 있는지 여부를 제어합니다	Does not work with `supportedIds` or `excludedIds` (`supportedIds` and `excludedIds` will be ignored).

기본값: false

예시:

privateAssistants: false

retrievalModels

키:

Key	Type	Description	Example
retrievalModels	Array/List of Strings	assistants endpoint에 대한 검색(retrieval)을 지원하는 모델을 지정합니다.	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.

기본값: [] (검색을 지원하는 최신 OpenAI 모델을 사용합니다)

예시:

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

capabilities

키:

Key	Type	Description	Example
capabilities	Array/List of Strings	assistants endpoint에 대해 모든 사용자에게 제공되는 어시스턴트 기능을 지정합니다.	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.

기본값: ["code_interpreter", "image_vision", "retrieval", "actions", "tools"]

예시:

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

참고: 이 필드는 선택 사항입니다. 생략할 경우, 예시에 나열된 모든 기능을 포함하는 것이 기본 동작입니다.