Udostępnij za pośrednictwem

Update Agent - Update Agent

  • Odwołanie
Usługa:
AI Foundry
Wersja interfejsu API:
v1

Modyfikuje istniejącego agenta.

POST {endpoint}/assistants/{assistantId}?api-version=v1

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
assistantId
 path True

string

Identyfikator agenta, który ma zostać zmodyfikowany.
endpoint
 path True

string (uri)

Punkt końcowy projektu w postaci: https://.services.ai.azure.com/api/projects/
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa Typ Opis
description

string

Zmodyfikowany opis używany przez agenta.
instructions

string

Zmodyfikowane instrukcje systemowe dotyczące nowego agenta do użycia.
metadata

object

Zestaw maksymalnie 16 par klucz/wartość, które mogą być dołączone do obiektu, używane do przechowywania dodatkowych informacji o tym obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć maksymalnie 512 znaków.
model

string

Identyfikator modelu do użycia.
name

string

Zmodyfikowana nazwa agenta do użycia.
response_format

AgentsResponseFormatOption

Format odpowiedzi wywołań narzędzia używanych przez tego agenta.
temperature

number (float)

Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będą bardziej skoncentrowane i deterministyczne.
tool_resources

ToolResources

Zestaw zasobów używanych przez narzędzia agenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.
tools ToolDefinition[]:

Zmodyfikowana kolekcja narzędzi w celu włączenia agenta.
top_p

number (float)

Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa.

Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.

Odpowiedzi

Nazwa Typ Opis
200 OK

Agent

Zaktualizowane wystąpienie agenta.
Other Status Codes

AgentV1Error

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa Opis
https://ai.azure.com/.default

Przykłady

UpdateAgent_MaximumSet
UpdateAgent_MinimumSet

UpdateAgent_MaximumSet

Przykładowe żądanie

POST {endpoint}/assistants/ddcetc?api-version=v1

{
  "model": "fpdidobbatloizzzdacgviknru",
  "name": "asghdbeeijhxiqpmbzzfpduxgevx",
  "description": "cvqpqhpdsylq",
  "instructions": "oejkibdgllcpoexljqasvvdxepbli",
  "tools": [
    {
      "type": "ToolDefinition"
    }
  ],
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv"
      ],
      "data_sources": [
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        }
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "ezeljyggzgyvliaif"
      ],
      "vector_stores": [
        {
          "name": "jtpzxxafdiapssaxxruzkitbpmdovh",
          "configuration": {
            "data_sources": [
              {
                "uri": "jtookuzhwojyylbips",
                "type": "uri_asset"
              }
            ]
          }
        }
      ]
    },
    "azure_ai_search": {
      "indexes": [
        {
          "index_connection_id": "nfeoncaophxqnhmsewmckkwbyv",
          "index_name": "nidrehbyzdpvelcltqqloq",
          "query_type": "simple",
          "top_k": 4,
          "filter": "hrfico",
          "index_asset_id": "wybmymisqviehjpplxbrjtmaxejq"
        }
      ]
    }
  },
  "temperature": 15,
  "top_p": 3,
  "metadata": {
    "key4821": "zykh"
  }
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "id": "ldgcuidjvzrp",
  "object": "assistant",
  "created_at": 1,
  "name": "mldxpytbtdtrukktpciqtkcttk",
  "description": "qvci",
  "model": "farpqexpvlgrwtjwawkbryjrxmt",
  "instructions": "csqxezmbgdisjpndkhvxbrbwpeftb",
  "tools": [
    {
      "type": "ToolDefinition"
    }
  ],
  "tool_resources": {
    "code_interpreter": {
      "file_ids": [
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv",
        "lrxbwhmsewnzmfushighvgbv"
      ],
      "data_sources": [
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        },
        {
          "uri": "jtookuzhwojyylbips",
          "type": "uri_asset"
        }
      ]
    },
    "file_search": {
      "vector_store_ids": [
        "ezeljyggzgyvliaif"
      ],
      "vector_stores": [
        {
          "name": "jtpzxxafdiapssaxxruzkitbpmdovh",
          "configuration": {
            "data_sources": [
              {
                "uri": "jtookuzhwojyylbips",
                "type": "uri_asset"
              }
            ]
          }
        }
      ]
    },
    "azure_ai_search": {
      "indexes": [
        {
          "index_connection_id": "nfeoncaophxqnhmsewmckkwbyv",
          "index_name": "nidrehbyzdpvelcltqqloq",
          "query_type": "simple",
          "top_k": 4,
          "filter": "hrfico",
          "index_asset_id": "wybmymisqviehjpplxbrjtmaxejq"
        }
      ]
    }
  },
  "temperature": 24,
  "top_p": 20,
  "metadata": {
    "key6403": "cafmabfintoktvmzcbkzrimxe"
  }
}

UpdateAgent_MinimumSet

Przykładowe żądanie

POST {endpoint}/assistants/ddcetc?api-version=v1

{}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "id": "ldgcuidjvzrp",
  "object": "assistant",
  "created_at": 1,
  "name": "mldxpytbtdtrukktpciqtkcttk",
  "description": "qvci",
  "model": "farpqexpvlgrwtjwawkbryjrxmt",
  "instructions": "csqxezmbgdisjpndkhvxbrbwpeftb",
  "tools": [
    {
      "type": "ToolDefinition"
    }
  ],
  "tool_resources": {},
  "temperature": 24,
  "top_p": 20,
  "metadata": {}
}

Definicje

Nazwa Opis
Agent

Reprezentuje agenta, który może wywoływać model i używać narzędzi.
AgentErrorDetail

Opisuje informacje o błędach zwracane przez interfejs API agentów.
AgentV1Error

Ładunek błędu zwrócony przez interfejs API agentów.
AISearchIndexResource

Zasób AI Search Index.
AzureAISearchQueryType

Dostępne typy zapytań dla narzędzia Azure AI Search.
AzureAISearchToolDefinition

Informacje o definicji danych wejściowych narzędzia wyszukiwania sztucznej inteligencji platformy Azure używane do konfigurowania agenta.
AzureAISearchToolResource

Zestaw zasobów indeksu używanych przez narzędzie azure_ai_search.
AzureFunctionBinding

Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.
AzureFunctionDefinition

Definicja funkcji platformy Azure.
AzureFunctionStorageQueue

Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.
AzureFunctionToolDefinition

Informacje o definicji danych wejściowych narzędzia funkcji platformy Azure używane do konfigurowania agenta.
BingGroundingSearchConfiguration

Wyszukaj konfigurację dla Bing Grounding
BingGroundingSearchToolParameters

Parametry narzędzia wyszukiwania uziemienia Bing.
BingGroundingToolDefinition

Informacje o definicji danych wejściowych narzędzia wyszukiwania uziemieniowego bing używane do konfigurowania agenta.
CodeInterpreterToolDefinition

Informacje o definicji danych wejściowych narzędzia interpretera kodu używane do konfigurowania agenta.
CodeInterpreterToolResource

Zestaw zasobów używanych przez narzędzie code_interpreter.
ConnectedAgentDetails

Informacje dotyczące łączenia jednego agenta z drugim jako narzędzia
ConnectedAgentToolDefinition

Informacje o definicji danych wejściowych dla narzędzia połączonego agenta, które definiuje agenta podrzędnego specyficznego dla domeny
FileSearchRankingOptions

Opcje klasyfikacji wyszukiwania plików.
FileSearchToolDefinition

Informacje o definicji wejściowej narzędzia wyszukiwania plików używane do konfigurowania agenta.
FileSearchToolDefinitionDetails

Opcje zastępują narzędzie wyszukiwania plików.
FileSearchToolResource

Zestaw zasobów używanych przez narzędzie file_search.
FunctionDefinition

Informacje o definicji danych wejściowych funkcji.
FunctionToolDefinition

Informacje o definicji danych wejściowych narzędzia funkcji używane do konfigurowania agenta.
OpenApiAnonymousAuthDetails

Szczegóły zabezpieczeń uwierzytelniania anonimowego openApi
OpenApiAuthType

Typ uwierzytelniania dla punktu końcowego OpenAPI. Dozwolone typy to:

  • Anonimowy (uwierzytelnianie nie jest wymagane)
  • Połączenie (wymaga connection_id do punktu końcowego, zgodnie z konfiguracją w AI Foundry)
  • Managed_Identity (wymaga odbiorców do uwierzytelniania opartego na tożsamości)
OpenApiConnectionAuthDetails

Szczegóły zabezpieczeń uwierzytelniania połączeń openApi
OpenApiConnectionSecurityScheme

Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity
OpenApiFunctionDefinition

Informacje o definicji danych wejściowych dla funkcji openapi.
OpenApiManagedAuthDetails

Szczegóły zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity
OpenApiManagedSecurityScheme

Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity
OpenApiToolDefinition

Informacje o definicji danych wejściowych narzędzia OpenAPI używane do konfigurowania agenta.
ToolResources

Zestaw zasobów używanych przez narzędzia agenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.
UpdateAgentOptions

Szczegóły żądania do użycia podczas modyfikowania istniejącego agenta.
VectorStoreConfiguration

Konfiguracja magazynu wektorowego to lista źródeł danych używanych w przypadku użycia wielu plików do wyszukiwania plików przedsiębiorstwa.
VectorStoreConfigurations

Struktura zawierająca listę konfiguracji magazynu wektorowego, tj. listę identyfikatorów zasobów platformy Azure.
VectorStoreDataSource

Struktura zawierająca ścieżkę identyfikatora URI zasobu platformy Azure i typ zasobu pliku używanego jako źródło danych dla wyszukiwania plików przedsiębiorstwa.
VectorStoreDataSourceAssetType

Typ zasobu magazynu wektorowego. Typ zasobu może być uri_asset, w tym przypadku powinien zawierać identyfikator URI zasobu, w przypadku id_asset powinien zawierać identyfikator danych.

Agent

Objekt

Reprezentuje agenta, który może wywoływać model i używać narzędzi.

Nazwa Typ Domyślna wartość Opis
created_at

integer (unixtime)

Sygnatura czasowa systemu Unix w sekundach reprezentująca czas utworzenia tego obiektu.
description

string

Opis agenta.
id

string

Identyfikator, do którego można odwoływać się w punktach końcowych interfejsu API.
instructions

string

Instrukcje systemowe dotyczące agenta do użycia.
metadata

object

Zestaw maksymalnie 16 par klucz/wartość, które mogą być dołączone do obiektu, używane do przechowywania dodatkowych informacji o tym obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć maksymalnie 512 znaków.
model

string

Identyfikator modelu do użycia.
name

string

Nazwa agenta.
object enum:

assistant

Typ obiektu, który jest zawsze asystentem.
response_format

AgentsResponseFormatOption

Format odpowiedzi wywołań narzędzia używanych przez tego agenta.
temperature

number (float)

1

Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będą bardziej skoncentrowane i deterministyczne.
tool_resources

ToolResources

Zestaw zasobów używanych przez narzędzia agenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.
tools ToolDefinition[]:

Kolekcja narzędzi włączona dla agenta.
top_p

number (float)

1

Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa.

Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.

AgentErrorDetail

Objekt

Opisuje informacje o błędach zwracane przez interfejs API agentów.

Nazwa Typ Opis
code

string

Kod błędu nadający się do odczytu maszynowego.
message

string

Opis błędu czytelny dla człowieka.
param

string

Nazwa parametru, który spowodował błąd, jeśli dotyczy.
type

string

Identyfikator typu błędu (np. invalid_request_error).

AgentV1Error

Objekt

Ładunek błędu zwrócony przez interfejs API agentów.

Nazwa Typ Opis
error

AgentErrorDetail

Reprezentuje błąd.

AISearchIndexResource

Objekt

Zasób AI Search Index.

Nazwa Typ Opis
filter

string

Filtruj ciąg dla zasobu wyszukiwania.
index_asset_id

string

Identyfikator zasobu indeksu dla zasobu wyszukiwania.
index_connection_id

string

Identyfikator połączenia indeksu w pliku IndexResource dołączony do tego agenta.
index_name

string

Nazwa indeksu w indeksieResource dołączonym do tego agenta.
query_type

AzureAISearchQueryType

Typ zapytania w AIIndexResource dołączony do tego agenta.
top_k

integer (int32)

Liczba dokumentów do pobrania z wyszukiwania i prezentowania do modelu.

AzureAISearchQueryType

Wyliczanie

Dostępne typy zapytań dla narzędzia Azure AI Search.

Wartość Opis
semantic

Typ zapytania semantic
simple

Typ zapytania simple
vector

Typ zapytania vector
vector_semantic_hybrid

Typ zapytania vector_semantic_hybrid
vector_simple_hybrid

Typ zapytania vector_simple_hybrid

AzureAISearchToolDefinition

Objekt

Informacje o definicji danych wejściowych narzędzia wyszukiwania sztucznej inteligencji platformy Azure używane do konfigurowania agenta.

Nazwa Typ Opis
type string:

azure_ai_search

Typ obiektu.

AzureAISearchToolResource

Objekt

Zestaw zasobów indeksu używanych przez narzędzie azure_ai_search.

Nazwa Typ Opis
indexes

AISearchIndexResource[]

Indeksy dołączone do tego agenta. Może istnieć maksymalnie 1 zasób indeksu dołączony do agenta.

AzureFunctionBinding

Objekt

Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.

Nazwa Typ Opis
storage_queue

AzureFunctionStorageQueue

Kolejka magazynu.
type enum:

storage_queue

Typ powiązania, który jest zawsze "storage_queue".

AzureFunctionDefinition

Objekt

Definicja funkcji platformy Azure.

Nazwa Typ Opis
function

FunctionDefinition

Definicja funkcji platformy Azure i jej parametrów.
input_binding

AzureFunctionBinding

Kolejka magazynu wejściowego. Wyzwalacz magazynu kolejek uruchamia funkcję w miarę dodawania do niej komunikatów.
output_binding

AzureFunctionBinding

Kolejka magazynu wyjściowego. Funkcja zapisuje dane wyjściowe w tej kolejce po przetworzeniu elementów wejściowych.

AzureFunctionStorageQueue

Objekt

Struktura przechowywania nazwy kolejki magazynu i identyfikatora URI.

Nazwa Typ Opis
queue_name

string

Nazwa kolejki usługi Azure Function Storage.
queue_service_endpoint

string

Identyfikator URI usługi Azure Storage Queue Service umożliwiający manipulowanie kolejką.

AzureFunctionToolDefinition

Objekt

Informacje o definicji danych wejściowych narzędzia funkcji platformy Azure używane do konfigurowania agenta.

Nazwa Typ Opis
azure_function

AzureFunctionDefinition

Definicja funkcji, którą narzędzie funkcji powinno wywołać.
type string:

azure_function

Typ obiektu.

BingGroundingSearchConfiguration

Objekt

Wyszukaj konfigurację dla Bing Grounding

Nazwa Typ Opis
connection_id

string

Identyfikator połączenia do uziemienia za pomocą wyszukiwania Bing
count

integer (int64)

Liczba wyników wyszukiwania do zwrócenia w odpowiedzi interfejsu API Bing
freshness

string

Filtruj wyniki wyszukiwania według określonego zakresu czasu. Dopuszczalne wartości: https://learn.microsoft.com/bing/search-apis/bing-web-search/reference/query-parameters
market

string

Rynek, z którego pochodzą wyniki.
set_lang

string

Język, który ma być używany dla ciągów interfejsu użytkownika podczas wywoływania interfejsu API Bing.

BingGroundingSearchToolParameters

Objekt

Parametry narzędzia wyszukiwania uziemienia Bing.

Nazwa Typ Opis
search_configurations

BingGroundingSearchConfiguration[]

Konfiguracje wyszukiwania dołączone do tego narzędzia. Do narzędzia może być dołączony maksymalnie 1 zasób konfiguracji wyszukiwania.

BingGroundingToolDefinition

Objekt

Informacje o definicji danych wejściowych narzędzia wyszukiwania uziemieniowego bing używane do konfigurowania agenta.

Nazwa Typ Opis
bing_grounding

BingGroundingSearchToolParameters

Parametry narzędzia wyszukiwania uziemienia Bing.
type string:

bing_grounding

Typ obiektu.

CodeInterpreterToolDefinition

Objekt

Informacje o definicji danych wejściowych narzędzia interpretera kodu używane do konfigurowania agenta.

Nazwa Typ Opis
type string:

code_interpreter

Typ obiektu.

CodeInterpreterToolResource

Objekt

Zestaw zasobów używanych przez narzędzie code_interpreter.

Nazwa Typ Opis
data_sources

VectorStoreDataSource[]

Źródła danych do użycia. Ta opcja wzajemnie wyklucza się z właściwością fileIds.
file_ids

string[]

Lista identyfikatorów plików udostępnionych narzędziu code_interpreter . Może istnieć maksymalnie 20 plików skojarzonych z narzędziem.

ConnectedAgentDetails

Objekt

Informacje dotyczące łączenia jednego agenta z drugim jako narzędzia

Nazwa Typ Opis
description

string

Opis tego, co robi agent, używany przez model do wybierania, kiedy i jak wywołać agenta.
id

string

Identyfikator agenta podrzędnego.
name

string

Imię i nazwisko agenta, który ma zostać wezwany.

ConnectedAgentToolDefinition

Objekt

Informacje o definicji danych wejściowych dla narzędzia połączonego agenta, które definiuje agenta podrzędnego specyficznego dla domeny

Nazwa Typ Opis
connected_agent

ConnectedAgentDetails

Agent podrzędny do nawiązania połączenia
type string:

connected_agent

Typ obiektu.

FileSearchRankingOptions

Objekt

Opcje klasyfikacji wyszukiwania plików.

Nazwa Typ Opis
ranker

string

Rangator wyszukiwania plików.
score_threshold

number (float)

Próg wyszukiwania klasyfikatora.

FileSearchToolDefinition

Objekt

Informacje o definicji wejściowej narzędzia wyszukiwania plików używane do konfigurowania agenta.

Nazwa Typ Opis
file_search

FileSearchToolDefinitionDetails

Opcje zastępują narzędzie wyszukiwania plików.
type string:

file_search

Typ obiektu.

FileSearchToolDefinitionDetails

Objekt

Opcje zastępują narzędzie wyszukiwania plików.

Nazwa Typ Opis
max_num_results

integer (int32)

minimum: 1
maximum: 50

Maksymalna liczba wyników, które narzędzie wyszukiwania plików powinno wyświetlić. Wartość domyślna to 20 dla modeli gpt-4* i 5 dla gpt-3,5-turbo. Ta liczba powinna należeć do zakresu od 1 do 50 włącznie.

Należy pamiętać, że narzędzie wyszukiwania plików może zwracać mniej niż max_num_results wyniki. Aby uzyskać więcej informacji, zobacz dokumentację narzędzia wyszukiwania plików.
ranking_options

FileSearchRankingOptions

Opcje klasyfikacji wyszukiwania plików.

FileSearchToolResource

Objekt

Zestaw zasobów używanych przez narzędzie file_search.

Nazwa Typ Opis
vector_store_ids

string[]

Identyfikator magazynu wektorów dołączony do tego agenta. Może istnieć maksymalnie 1 magazyn wektorów dołączony do agenta.
vector_stores

VectorStoreConfigurations[]

Lista obiektów konfiguracji magazynu wektorów z platformy Azure. Ta lista jest ograniczona do jednego elementu. Jedynym elementem tej listy jest lista identyfikatorów zasobów platformy Azure używanych przez narzędzie wyszukiwania.

FunctionDefinition

Objekt

Informacje o definicji danych wejściowych funkcji.

Nazwa Typ Opis
description

string

Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.
name

string

Nazwa funkcji do wywołania.
parameters

Parametry akceptowane przez funkcje, opisane jako obiekt schematu JSON.

FunctionToolDefinition

Objekt

Informacje o definicji danych wejściowych narzędzia funkcji używane do konfigurowania agenta.

Nazwa Typ Opis
function

FunctionDefinition

Definicja funkcji, którą narzędzie funkcji powinno wywołać.
type string:

function

Typ obiektu.

OpenApiAnonymousAuthDetails

Objekt

Szczegóły zabezpieczeń uwierzytelniania anonimowego openApi

Nazwa Typ Opis
type string:

anonymous

Typ uwierzytelniania musi być anonimowy/połączenie/managed_identity

OpenApiAuthType

Wyliczanie

Typ uwierzytelniania dla punktu końcowego OpenAPI. Dozwolone typy to:

  • Anonimowy (uwierzytelnianie nie jest wymagane)
  • Połączenie (wymaga connection_id do punktu końcowego, zgodnie z konfiguracją w AI Foundry)
  • Managed_Identity (wymaga odbiorców do uwierzytelniania opartego na tożsamości)
Wartość Opis
anonymous
connection
managed_identity

OpenApiConnectionAuthDetails

Objekt

Szczegóły zabezpieczeń uwierzytelniania połączeń openApi

Nazwa Typ Opis
security_scheme

OpenApiConnectionSecurityScheme

Szczegóły zabezpieczeń uwierzytelniania połączenia
type string:

connection

Typ uwierzytelniania musi być anonimowy/połączenie/managed_identity

OpenApiConnectionSecurityScheme

Objekt

Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

Nazwa Typ Opis
connection_id

string

Identyfikator połączenia dla typu uwierzytelniania połączenia

OpenApiFunctionDefinition

Objekt

Informacje o definicji danych wejściowych dla funkcji openapi.

Nazwa Typ Opis
auth OpenApiAuthDetails:

Szczegóły uwierzytelniania interfejsu API
default_params

string[]

Lista parametrów specyfikacji interfejsu OpenAPI, które będą używać domyślnych ustawień udostępnionych przez użytkownika
description

string

Opis działania funkcji używanej przez model do wyboru, kiedy i jak wywołać funkcję.
functions

FunctionDefinition[]

Lista definicji funkcji używanych przez narzędzie OpenApi
name

string

Nazwa funkcji do wywołania.
spec

Kształt funkcji openapi opisany jako obiekt schematu JSON.

OpenApiManagedAuthDetails

Objekt

Szczegóły zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

Nazwa Typ Opis
security_scheme

OpenApiManagedSecurityScheme

Szczegóły zabezpieczeń uwierzytelniania połączenia
type string:

managed_identity

Typ uwierzytelniania musi być anonimowy/połączenie/managed_identity

OpenApiManagedSecurityScheme

Objekt

Schemat zabezpieczeń uwierzytelniania interfejsu OpenApi managed_identity

Nazwa Typ Opis
audience

string

Zakres uwierzytelniania dla typu uwierzytelniania managed_identity

OpenApiToolDefinition

Objekt

Informacje o definicji danych wejściowych narzędzia OpenAPI używane do konfigurowania agenta.

Nazwa Typ Opis
openapi

OpenApiFunctionDefinition

Definicja funkcji openapi.
type string:

openapi

Typ obiektu.

ToolResources

Objekt

Zestaw zasobów używanych przez narzędzia agenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.

Nazwa Typ Opis
azure_ai_search

AzureAISearchToolResource

Zasoby używane przez narzędzie azure_ai_search składające się z identyfikatorów indeksów i nazw.
code_interpreter

CodeInterpreterToolResource

Zasoby używane przez narzędzie code_interpreter składające się z identyfikatorów plików.
file_search

FileSearchToolResource

Zasoby używane przez narzędzie file_search składające się z identyfikatorów magazynów wektorowych.

UpdateAgentOptions

Objekt

Szczegóły żądania do użycia podczas modyfikowania istniejącego agenta.

Nazwa Typ Domyślna wartość Opis
description

string

Zmodyfikowany opis używany przez agenta.
instructions

string

Zmodyfikowane instrukcje systemowe dotyczące nowego agenta do użycia.
metadata

object

Zestaw maksymalnie 16 par klucz/wartość, które mogą być dołączone do obiektu, używane do przechowywania dodatkowych informacji o tym obiekcie w formacie ustrukturyzowanym. Klucze mogą mieć długość maksymalnie 64 znaków, a wartości mogą mieć maksymalnie 512 znaków.
model

string

Identyfikator modelu do użycia.
name

string

Zmodyfikowana nazwa agenta do użycia.
response_format

AgentsResponseFormatOption

Format odpowiedzi wywołań narzędzia używanych przez tego agenta.
temperature

number (float)

1

Jaka temperatura próbkowania ma być używana z zakresu od 0 do 2. Wyższe wartości, takie jak 0,8, sprawią, że dane wyjściowe będą bardziej losowe, a niższe wartości, takie jak 0,2, sprawią, że będą bardziej skoncentrowane i deterministyczne.
tool_resources

ToolResources

Zestaw zasobów używanych przez narzędzia agenta. Zasoby są specyficzne dla typu narzędzia. Na przykład code_interpreter narzędzie wymaga listy identyfikatorów plików, a file_search narzędzie wymaga listy identyfikatorów magazynów wektorów.
tools ToolDefinition[]:

Zmodyfikowana kolekcja narzędzi w celu włączenia agenta.
top_p

number (float)

1

Alternatywa dla próbkowania z temperaturą, zwana próbkowaniem jądra, gdzie model uwzględnia wyniki tokenów z masą prawdopodobieństwa top_p. Dlatego 0,1 oznacza, że uwzględniane są tylko tokeny znajdujące się w górnych 10% masy prawdopodobieństwa.

Ogólnie zalecamy zmianę tej wartości lub temperatury, ale nie obu.

VectorStoreConfiguration

Objekt

Konfiguracja magazynu wektorowego to lista źródeł danych używanych w przypadku użycia wielu plików do wyszukiwania plików przedsiębiorstwa.

Nazwa Typ Opis
data_sources

VectorStoreDataSource[]

Źródła danych

VectorStoreConfigurations

Objekt

Struktura zawierająca listę konfiguracji magazynu wektorowego, tj. listę identyfikatorów zasobów platformy Azure.

Nazwa Typ Opis
configuration

VectorStoreConfiguration

Konfiguracje
name

string

Nazwa

VectorStoreDataSource

Objekt

Struktura zawierająca ścieżkę identyfikatora URI zasobu platformy Azure i typ zasobu pliku używanego jako źródło danych dla wyszukiwania plików przedsiębiorstwa.

Nazwa Typ Opis
type

VectorStoreDataSourceAssetType

Typ zasobu
uri

string

Identyfikator URI zasobu.

VectorStoreDataSourceAssetType

Wyliczanie

Typ zasobu magazynu wektorowego. Typ zasobu może być uri_asset, w tym przypadku powinien zawierać identyfikator URI zasobu, w przypadku id_asset powinien zawierać identyfikator danych.

Wartość Opis
id_asset

Identyfikator danych
uri_asset

Azure URI