Knowledge Agents - List

Referentie

Service:: Search Service

API-versie:: 2025-05-01-preview

Geeft een overzicht van alle agenten die beschikbaar zijn voor een zoekservice.

GET {endpoint}/agents?api-version=2025-05-01-preview

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	De tracerings-id die is verzonden met de aanvraag om hulp te bieden bij foutopsporing.

Antwoorden

Name	Type	Description
200 OK	ListKnowledgeAgentsResult
Other Status Codes	ErrorResponse	Foutreactie.

Voorbeelden

SearchServiceListKnowledgeAgents

Voorbeeldaanvraag

HTTP

GET https://previewexampleservice.search.windows.net/agents?api-version=2025-05-01-preview

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "@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>"
        }
      }
    }
  ]
}

Definities

Name	Description
AzureActiveDirectoryApplicationCredentials	Referenties van een geregistreerde toepassing die is gemaakt voor uw zoekservice, die wordt gebruikt voor geverifieerde toegang tot de versleutelingssleutels die zijn opgeslagen in Azure Key Vault.
AzureOpenAIEmbeddingSkill	Hiermee kunt u een vector insluiten voor een bepaalde tekstinvoer genereren met behulp van de Azure OpenAI-resource.
AzureOpenAIModelName	De naam van het Azure Open AI-model die wordt aangeroepen.
AzureOpenAIParameters	Hiermee geeft u de parameters voor het maken van verbinding met de Azure OpenAI-resource.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
InputFieldMappingEntry	Invoerveldtoewijzing voor een vaardigheid.
KnowledgeAgent
KnowledgeAgentAzureOpenAIModel	Hiermee geeft u de Azure OpenAI-resource op die wordt gebruikt om queryplanning uit te voeren.
KnowledgeAgentModelKind	Het AI-model dat moet worden gebruikt voor queryplanning.
KnowledgeAgentRequestLimits	Vangrails om te beperken hoeveel middelen worden gebruikt voor een verzoek om één agent op te halen.
KnowledgeAgentTargetIndex
ListKnowledgeAgentsResult
OutputFieldMappingEntry	Uitvoerveldtoewijzing voor een vaardigheid.
SearchIndexerDataNoneIdentity	Hiermee wist u de identiteitseigenschap van een gegevensbron.
SearchIndexerDataUserAssignedIdentity	Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt.
SearchResourceEncryptionKey	Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt voor het versleutelen of ontsleutelen van data-at-rest, zoals indexen en synoniemenkaarten.

AzureActiveDirectoryApplicationCredentials

Object

Referenties van een geregistreerde toepassing die is gemaakt voor uw zoekservice, die wordt gebruikt voor geverifieerde toegang tot de versleutelingssleutels die zijn opgeslagen in Azure Key Vault.

Name	Type	Description
applicationId	string	Een AAD-toepassings-id waaraan de vereiste toegangsmachtigingen zijn verleend voor de Azure Key Vault die moet worden gebruikt bij het versleutelen van uw data-at-rest. De toepassings-id mag niet worden verward met de object-id voor uw AAD-toepassing.
applicationSecret	string	De verificatiesleutel van de opgegeven AAD-toepassing.

AzureOpenAIEmbeddingSkill

Object

Hiermee kunt u een vector insluiten voor een bepaalde tekstinvoer genereren met behulp van de Azure OpenAI-resource.

Name	Type	Description
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	Een URI-fragment dat het type vaardigheid aangeeft.
apiKey	string	API-sleutel van de aangewezen Azure OpenAI-resource.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	De door de gebruiker toegewezen beheerde identiteit die wordt gebruikt voor uitgaande verbindingen.
context	string	Vertegenwoordigt het niveau waarop bewerkingen plaatsvinden, zoals de hoofdmap van het document of de inhoud van het document (bijvoorbeeld /document of /document/inhoud). De standaardwaarde is /document.
deploymentId	string	Id van de implementatie van het Azure OpenAI-model op de aangewezen resource.
description	string	De beschrijving van de vaardigheid die de invoer, uitvoer en het gebruik van de vaardigheid beschrijft.
dimensions	integer (int32)	Het aantal dimensies dat de resulterende uitvoer-insluitingen moeten hebben. Alleen ondersteund in modellen met tekst insluiten-3 en hoger.
inputs	InputFieldMappingEntry[]	Invoer van de vaardigheden kan een kolom zijn in de brongegevensset of de uitvoer van een upstream-vaardigheid.
modelName	AzureOpenAIModelName	De naam van het insluitmodel dat is geïmplementeerd op het opgegeven deploymentId-pad.
name	string	De naam van de vaardigheid die deze uniek identificeert in de vaardighedenset. Een vaardigheid zonder gedefinieerde naam krijgt een standaardnaam van de op 1 gebaseerde index in de vaardighedenmatrix, voorafgegaan door het teken '#'.
outputs	OutputFieldMappingEntry[]	De uitvoer van een vaardigheid is een veld in een zoekindex of een waarde die kan worden gebruikt als invoer door een andere vaardigheid.
resourceUri	string (uri)	De resource-URI van de Azure OpenAI-resource.

AzureOpenAIModelName

Inventarisatie

De naam van het Azure Open AI-model die wordt aangeroepen.

Waarde	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

Object

Hiermee geeft u de parameters voor het maken van verbinding met de Azure OpenAI-resource.

Name	Type	Description
apiKey	string	API-sleutel van de aangewezen Azure OpenAI-resource.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	De door de gebruiker toegewezen beheerde identiteit die wordt gebruikt voor uitgaande verbindingen.
deploymentId	string	Id van de implementatie van het Azure OpenAI-model op de aangewezen resource.
modelName	AzureOpenAIModelName	De naam van het insluitmodel dat is geïmplementeerd op het opgegeven deploymentId-pad.
resourceUri	string (uri)	De resource-URI van de Azure OpenAI-resource.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

InputFieldMappingEntry

Object

Invoerveldtoewijzing voor een vaardigheid.

Name	Type	Description
inputs	InputFieldMappingEntry[]	De recursieve invoer die wordt gebruikt bij het maken van een complex type.
name	string	De naam van de invoer.
source	string	De bron van de invoer.
sourceContext	string	De broncontext die wordt gebruikt voor het selecteren van recursieve invoer.

KnowledgeAgent

Object

Name	Type	Description
@odata.etag	string	De ETag van de agent.
description	string	De beschrijving van de agent.
encryptionKey	SearchResourceEncryptionKey	Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra niveau van versleuteling-at-rest te bieden voor uw agentdefinitie wanneer u volledige zekerheid wilt dat niemand, zelfs Microsoft niet, deze kan ontsleutelen. Zodra u uw agentdefinitie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap in te stellen op null. U kunt deze eigenschap naar wens wijzigen als u uw coderingssleutel wilt roteren; Uw agentdefinitie blijft onaangetast. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.
models	KnowledgeAgentModel[]: KnowledgeAgentAzureOpenAIModel[]	Bevat configuratieopties voor het maken van verbinding met AI-modellen.
name	string	De naam van de kennisagent.
requestLimits	KnowledgeAgentRequestLimits	Vangrails om te beperken hoeveel middelen worden gebruikt voor een verzoek om één agent op te halen.
targetIndexes	KnowledgeAgentTargetIndex[]

KnowledgeAgentAzureOpenAIModel

Object

Hiermee geeft u de Azure OpenAI-resource op die wordt gebruikt om queryplanning uit te voeren.

Name	Type	Description
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Bevat de parameters die specifiek zijn voor het Azure OpenAI-modeleindpunt.
kind	string: azureOpenAI	Het type AI-model.

KnowledgeAgentModelKind

Inventarisatie

Het AI-model dat moet worden gebruikt voor queryplanning.

Waarde	Description
azureOpenAI	Gebruik Azure Open AI-modellen voor het plannen van query's.

KnowledgeAgentRequestLimits

Object

Vangrails om te beperken hoeveel middelen worden gebruikt voor een verzoek om één agent op te halen.

Name	Type	Description
maxOutputSize	integer (int32)	Hiermee beperkt u de maximale grootte van de inhoud in de uitvoer.
maxRuntimeInSeconds	integer (int32)	De maximale looptijd in seconden.

KnowledgeAgentTargetIndex

Object

Name	Type	Description
defaultIncludeReferenceSourceData	boolean	Geeft aan of referentiebrongegevens moeten worden opgenomen.
defaultMaxDocsForReranker	integer (int32)	Beperkt het aantal documenten dat in aanmerking komt voor rangschikking.
defaultRerankerThreshold	number (float) minimum: 0 maximum: 4	Een drempel voor het opnieuw rangschikken van de resultaten (bereik: 0-4).
indexName	string	De naam van de doelindex.

ListKnowledgeAgentsResult

Object

Name	Type	Description
value	KnowledgeAgent[]

OutputFieldMappingEntry

Object

Uitvoerveldtoewijzing voor een vaardigheid.

Name	Type	Description
name	string	De naam van de uitvoer die is gedefinieerd door de vaardigheid.
targetName	string	De doelnaam van de uitvoer. Dit is optioneel en is standaard ingesteld op naam.

SearchIndexerDataNoneIdentity

Object

Hiermee wist u de identiteitseigenschap van een gegevensbron.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Een URI-fragment dat het type identiteit aangeeft.

SearchIndexerDataUserAssignedIdentity

Object

Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Een URI-fragment dat het type identiteit aangeeft.
userAssignedIdentity	string	De volledig gekwalificeerde Azure-resource-id van een door de gebruiker toegewezen beheerde identiteit, meestal in de vorm '/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId' die aan de zoekservice moet zijn toegewezen.

SearchResourceEncryptionKey

Object

Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt voor het versleutelen of ontsleutelen van data-at-rest, zoals indexen en synoniemenkaarten.

Name	Type	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Optionele Azure Active Directory-referenties die worden gebruikt voor toegang tot uw Azure Key Vault. Niet vereist als u in plaats daarvan beheerde identiteit gebruikt.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Een expliciete beheerde identiteit die moet worden gebruikt voor deze versleutelingssleutel. Als dit niet is opgegeven en de eigenschap toegangsreferenties null is, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Bij het bijwerken van de resource, als de expliciete identiteit niet is opgegeven, blijft deze ongewijzigd. Als 'geen' is opgegeven, wordt de waarde van deze eigenschap gewist.
keyVaultKeyName	string	De naam van uw Azure Key Vault-sleutel die moet worden gebruikt om uw data-at-rest te versleutelen.
keyVaultKeyVersion	string	De versie van uw Azure Key Vault-sleutel die moet worden gebruikt om uw data-at-rest te versleutelen.
keyVaultUri	string	De URI van uw Azure Key Vault, ook wel DNS-naam genoemd, die de sleutel bevat die moet worden gebruikt voor het versleutelen van uw data-at-rest. Een voorbeeld van een URI kan `https://my-keyvault-name.vault.azure.net`zijn.

Delen via

Knowledge Agents - List

URI-parameters

Aanvraagkoptekst

Antwoorden

Voorbeelden

SearchServiceListKnowledgeAgents

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AzureActiveDirectoryApplicationCredentials

AzureOpenAIEmbeddingSkill

AzureOpenAIModelName

AzureOpenAIParameters

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InputFieldMappingEntry

KnowledgeAgent

KnowledgeAgentAzureOpenAIModel

KnowledgeAgentModelKind

KnowledgeAgentRequestLimits

KnowledgeAgentTargetIndex

ListKnowledgeAgentsResult

OutputFieldMappingEntry

SearchIndexerDataNoneIdentity

SearchIndexerDataUserAssignedIdentity

SearchResourceEncryptionKey