Knowledge Agents - Get

Reference

Služba:: Search Service

Verze rozhraní API:: 2025-05-01-preview

Načte definici agenta.

GET {endpoint}/agents('{agentName}')?api-version=2025-05-01-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
agentName	path	True	string	Název agenta, který se má načíst.
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	ID sledování odeslané s požadavkem, které vám pomůže s laděním.

Odpovědi

Name	Typ	Description
200 OK	KnowledgeAgent
Other Status Codes	ErrorResponse	Chybová odpověď.

Příklady

SearchServiceGetKnowledgeAgent

Ukázkový požadavek

HTTP

GET https://previewexampleservice.search.windows.net/agents('agent-preview-test')?api-version=2025-05-01-preview

Ukázková odpověď

Stavový kód:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "agent-preview-test",
  "description": "Description of the agent.",
  "targetIndexes": [
    {
      "indexName": "preview-test",
      "defaultRerankerThreshold": 2.5,
      "defaultIncludeReferenceSourceData": true,
      "defaultMaxDocsForReranker": 100
    }
  ],
  "models": [
    {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com",
        "deploymentId": "myDeployment",
        "apiKey": "<redacted>",
        "modelName": "gpt-4o-mini"
      }
    }
  ],
  "requestLimits": {
    "maxRuntimeInSeconds": 60,
    "maxOutputSize": 100000
  },
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Definice

Name	Description
AzureActiveDirectoryApplicationCredentials	Přihlašovací údaje registrované aplikace vytvořené pro vaši vyhledávací službu, které slouží k ověřenému přístupu k šifrovacím klíčům uloženým ve službě Azure Key Vault.
AzureOpenAIEmbeddingSkill	Umožňuje vygenerovat vektorové vkládání pro daný textový vstup pomocí prostředku Azure OpenAI.
AzureOpenAIModelName	Název modelu Azure Open AI, který se bude volat.
AzureOpenAIParameters	Určuje parametry pro připojení k prostředku Azure OpenAI.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
InputFieldMappingEntry	Mapování vstupních polí pro dovednost
KnowledgeAgent
KnowledgeAgentAzureOpenAIModel	Určuje prostředek Azure OpenAI používaný k plánování dotazů.
KnowledgeAgentModelKind	Model umělé inteligence, který se má použít pro plánování dotazů.
KnowledgeAgentRequestLimits	Mantinely pro omezení množství prostředků využitých pro jeden požadavek na načtení agenta.
KnowledgeAgentTargetIndex
OutputFieldMappingEntry	Mapování výstupních polí pro dovednost
SearchIndexerDataNoneIdentity	Vymaže vlastnost identity zdroje dat.
SearchIndexerDataUserAssignedIdentity	Určuje identitu zdroje dat, která se má použít.
SearchResourceEncryptionKey	Šifrovací klíč spravovaný zákazníkem ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, se dají použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.

AzureActiveDirectoryApplicationCredentials

Objekt

Přihlašovací údaje registrované aplikace vytvořené pro vaši vyhledávací službu, které slouží k ověřenému přístupu k šifrovacím klíčům uloženým ve službě Azure Key Vault.

Name	Typ	Description
applicationId	string	ID aplikace AAD, kterému byla udělena požadovaná přístupová oprávnění ke službě Azure Key Vault, která se má použít při šifrování neaktivních uložených dat. ID aplikace by nemělo být zaměňováno s ID objektu pro vaši aplikaci AAD.
applicationSecret	string	Ověřovací klíč zadané aplikace AAD.

AzureOpenAIEmbeddingSkill

Objekt

Umožňuje vygenerovat vektorové vkládání pro daný textový vstup pomocí prostředku Azure OpenAI.

Name	Typ	Description
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	Fragment identifikátoru URI určující typ dovednosti.
apiKey	string	Klíč rozhraní API určeného prostředku Azure OpenAI
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Spravovaná identita přiřazená uživatelem používaná pro odchozí připojení.
context	string	Představuje úroveň, na které se provádí operace, například kořenový dokument nebo obsah dokumentu (například /document nebo /document/content). Výchozí hodnota je /document.
deploymentId	string	ID nasazení modelu Azure OpenAI v určeném prostředku
description	string	Popis dovednosti, která popisuje vstupy, výstupy a využití dovednosti.
dimensions	integer (int32)	Početdimenzích Podporuje se pouze v modelech pro vkládání textu 3 a novějších.
inputs	InputFieldMappingEntry[]	Vstupy dovedností můžou být sloupec ve zdrojové sadě dat nebo výstup upstreamové dovednosti.
modelName	AzureOpenAIModelName	Název modelu vložení, který je nasazený na zadané cestě deploymentId.
name	string	Název dovednosti, která ji jednoznačně identifikuje v sadě dovedností. Dovednost bez definovaného názvu bude mít výchozí název indexu založeného na 1 v poli dovedností s předponou znaku #.
outputs	OutputFieldMappingEntry[]	Výstupem dovednosti je buď pole v indexu vyhledávání, nebo hodnota, kterou lze využívat jako vstup jinou dovedností.
resourceUri	string (uri)	Identifikátor URI prostředku Azure OpenAI.

AzureOpenAIModelName

Výčet

Název modelu Azure Open AI, který se bude volat.

Hodnota	Description
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano
gpt-4o
gpt-4o-mini
text-embedding-3-large
text-embedding-3-small
text-embedding-ada-002

AzureOpenAIParameters

Objekt

Určuje parametry pro připojení k prostředku Azure OpenAI.

Name	Typ	Description
apiKey	string	Klíč rozhraní API určeného prostředku Azure OpenAI
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Spravovaná identita přiřazená uživatelem používaná pro odchozí připojení.
deploymentId	string	ID nasazení modelu Azure OpenAI v určeném prostředku
modelName	AzureOpenAIModelName	Název modelu vložení, který je nasazený na zadané cestě deploymentId.
resourceUri	string (uri)	Identifikátor URI prostředku Azure OpenAI.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

InputFieldMappingEntry

Objekt

Mapování vstupních polí pro dovednost

Name	Typ	Description
inputs	InputFieldMappingEntry[]	Rekurzivní vstupy použité při vytváření komplexního typu.
name	string	Název vstupu.
source	string	Zdroj vstupu.
sourceContext	string	Zdrojový kontext použitý pro výběr rekurzivních vstupů.

KnowledgeAgent

Objekt

Name	Typ	Description
@odata.etag	string	Značka ETag agenta.
description	string	Popis agenta.
encryptionKey	SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte ve službě Azure Key Vault. Tento klíč se používá k poskytnutí další úrovně šifrování neaktivních uložených dat pro definici agenta, když chcete mít plnou jistotu, že je nikdo, ani Microsoft, nemůže dešifrovat. Jakmile definici agenta zašifrujete, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Tuto vlastnost můžete podle potřeby změnit, pokud chcete šifrovací klíč otočit; Definice agenta nebude ovlivněna. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo po 1. lednu 2019.
models	KnowledgeAgentModel[]: KnowledgeAgentAzureOpenAIModel[]	Obsahuje možnosti konfigurace, jak se připojit k modelům AI.
name	string	Název znalostního agenta.
requestLimits	KnowledgeAgentRequestLimits	Mantinely pro omezení množství prostředků využitých pro jeden požadavek na načtení agenta.
targetIndexes	KnowledgeAgentTargetIndex[]

KnowledgeAgentAzureOpenAIModel

Objekt

Určuje prostředek Azure OpenAI používaný k plánování dotazů.

Name	Typ	Description
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Obsahuje parametry specifické pro koncový bod modelu Azure OpenAI.
kind	string: azureOpenAI	Typ modelu AI.

KnowledgeAgentModelKind

Výčet

Model umělé inteligence, který se má použít pro plánování dotazů.

Hodnota	Description
azureOpenAI	K plánování dotazů používejte modely Azure Open AI.

KnowledgeAgentRequestLimits

Objekt

Mantinely pro omezení množství prostředků využitých pro jeden požadavek na načtení agenta.

Name	Typ	Description
maxOutputSize	integer (int32)	Omezuje maximální velikost obsahu ve výstupu.
maxRuntimeInSeconds	integer (int32)	Maximální doba běhu v sekundách.

KnowledgeAgentTargetIndex

Objekt

Name	Typ	Description
defaultIncludeReferenceSourceData	boolean	Označuje, zda mají být zahrnuta referenční zdrojová data.
defaultMaxDocsForReranker	integer (int32)	Omezuje počet dokumentů zvažovaných pro pořadí.
defaultRerankerThreshold	number (float) minimum: 0 maximum: 4	Práh pro změnu pořadí výsledků (rozsah: 0–4).
indexName	string	Název cílového indexu.

OutputFieldMappingEntry

Objekt

Mapování výstupních polí pro dovednost

Name	Typ	Description
name	string	Název výstupu definovaného dovedností.
targetName	string	Cílový název výstupu. Je nepovinný a výchozí název.

SearchIndexerDataNoneIdentity

Objekt

Vymaže vlastnost identity zdroje dat.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment identifikátoru URI určující typ identity.

SearchIndexerDataUserAssignedIdentity

Objekt

Určuje identitu zdroje dat, která se má použít.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment identifikátoru URI určující typ identity.
userAssignedIdentity	string	Plně kvalifikované ID prostředku Azure spravované identity přiřazené uživatelem obvykle ve formátu /subscriptions/12345678-1234-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId, které by měly být přiřazeny vyhledávací službě.

SearchResourceEncryptionKey

Objekt

Šifrovací klíč spravovaný zákazníkem ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, se dají použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.

Name	Typ	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Volitelné přihlašovací údaje Azure Active Directory používané pro přístup ke službě Azure Key Vault. Nevyžaduje se, pokud místo toho používáte spravovanou identitu.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadána vlastnost přihlašovacích údajů přístupu null, použije se spravovaná identita přiřazená systémem. Při aktualizaci prostředku zůstane explicitní identita beze změny. Pokud je zadána hodnota "none", hodnota této vlastnosti je vymazána.
keyVaultKeyName	string	Název klíče služby Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultKeyVersion	string	Verze klíče služby Azure Key Vault, která se má použít k šifrování neaktivních uložených dat.
keyVaultUri	string	Identifikátor URI služby Azure Key Vault, označovaný také jako název DNS, který obsahuje klíč, který se má použít k šifrování neaktivních uložených dat. Příkladem identifikátoru URI může být `https://my-keyvault-name.vault.azure.net`.

Sdílet prostřednictvím

Knowledge Agents - Get

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Příklady

SearchServiceGetKnowledgeAgent

Ukázkový požadavek

Ukázková odpověď

Definice

AzureActiveDirectoryApplicationCredentials

AzureOpenAIEmbeddingSkill

AzureOpenAIModelName

AzureOpenAIParameters

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InputFieldMappingEntry

KnowledgeAgent

KnowledgeAgentAzureOpenAIModel

KnowledgeAgentModelKind

KnowledgeAgentRequestLimits

KnowledgeAgentTargetIndex

OutputFieldMappingEntry

SearchIndexerDataNoneIdentity

SearchIndexerDataUserAssignedIdentity

SearchResourceEncryptionKey