Knowledge Agents - List

Referencia

Servicio:: Search Service

Versión de la API:: 2025-05-01-preview

Enumera todos los agentes disponibles para un servicio de búsqueda.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Dirección URL del punto de conexión del servicio de búsqueda.
api-version	query	True	string	Versión de api de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Respuestas

Nombre	Tipo	Description
200 OK	ListKnowledgeAgentsResult
Other Status Codes	ErrorResponse	Respuesta de error.

Ejemplos

SearchServiceListKnowledgeAgents

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 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>"
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
AzureActiveDirectoryApplicationCredentials	Credenciales de una aplicación registrada creada para el servicio de búsqueda, que se usa para el acceso autenticado a las claves de cifrado almacenadas en Azure Key Vault.
AzureOpenAIEmbeddingSkill	Permite generar una inserción de vectores para una entrada de texto determinada mediante el recurso de Azure OpenAI.
AzureOpenAIModelName	Nombre del modelo de Azure Open AI al que se llamará.
AzureOpenAIParameters	Especifica los parámetros para conectarse al recurso de Azure OpenAI.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
InputFieldMappingEntry	Asignación de campos de entrada para una aptitud.
KnowledgeAgent
KnowledgeAgentAzureOpenAIModel	Especifica el recurso de Azure OpenAI que se usa para realizar el planeamiento de consultas.
KnowledgeAgentModelKind	El modelo de IA que se usará para la planeación de consultas.
KnowledgeAgentRequestLimits	Barreras de protección para limitar la cantidad de recursos que se utilizan para una solicitud de recuperación de un solo agente.
KnowledgeAgentTargetIndex
ListKnowledgeAgentsResult
OutputFieldMappingEntry	Asignación de campos de salida para una aptitud.
SearchIndexerDataNoneIdentity	Borra la propiedad de identidad de un origen de datos.
SearchIndexerDataUserAssignedIdentity	Especifica la identidad de un origen de datos que se va a usar.
SearchResourceEncryptionKey	Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que cree y administre se pueden usar para cifrar o descifrar datos en reposo, como índices y mapas de sinónimos.

AzureActiveDirectoryApplicationCredentials

Object

Credenciales de una aplicación registrada creada para el servicio de búsqueda, que se usa para el acceso autenticado a las claves de cifrado almacenadas en Azure Key Vault.

Nombre	Tipo	Description
applicationId	string	Un identificador de aplicación de AAD al que se concedieron los permisos de acceso necesarios a Azure Key Vault que se va a usar al cifrar los datos en reposo. El identificador de aplicación no debe confundirse con el id. de objeto de la aplicación de AAD.
applicationSecret	string	Clave de autenticación de la aplicación de AAD especificada.

AzureOpenAIEmbeddingSkill

Object

Permite generar una inserción de vectores para una entrada de texto determinada mediante el recurso de Azure OpenAI.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	Fragmento de URI que especifica el tipo de aptitud.
apiKey	string	Clave de API del recurso de Azure OpenAI designado.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	La identidad administrada asignada por el usuario que se usa para las conexiones salientes.
context	string	Representa el nivel en el que tienen lugar las operaciones, como la raíz del documento o el contenido del documento (por ejemplo, /document o /document/content). El valor predeterminado es /document.
deploymentId	string	Identificador de la implementación del modelo de Azure OpenAI en el recurso designado.
description	string	Descripción de la aptitud que describe las entradas, salidas y uso de la aptitud.
dimensions	integer (int32)	Número de dimensiones que deben tener las incrustaciones de salida resultantes. Solo se admite en los modelos text-embeding-3 y versiones posteriores.
inputs	InputFieldMappingEntry[]	Las entradas de las aptitudes podrían ser una columna del conjunto de datos de origen o la salida de una aptitud ascendente.
modelName	AzureOpenAIModelName	Nombre del modelo de inserción que se implementa en la ruta de acceso deploymentId proporcionada.
name	string	Nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una aptitud sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de aptitudes, con el prefijo "#".
outputs	OutputFieldMappingEntry[]	La salida de una aptitud es un campo en un índice de búsqueda o un valor que otra aptitud puede consumir como entrada.
resourceUri	string (uri)	Identificador URI del recurso de Azure OpenAI.

AzureOpenAIModelName

Enumeración

Nombre del modelo de Azure Open AI al que se llamará.

Valor	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

Especifica los parámetros para conectarse al recurso de Azure OpenAI.

Nombre	Tipo	Description
apiKey	string	Clave de API del recurso de Azure OpenAI designado.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	La identidad administrada asignada por el usuario que se usa para las conexiones salientes.
deploymentId	string	Identificador de la implementación del modelo de Azure OpenAI en el recurso designado.
modelName	AzureOpenAIModelName	Nombre del modelo de inserción que se implementa en la ruta de acceso deploymentId proporcionada.
resourceUri	string (uri)	Identificador URI del recurso de Azure OpenAI.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

InputFieldMappingEntry

Object

Asignación de campos de entrada para una aptitud.

Nombre	Tipo	Description
inputs	InputFieldMappingEntry[]	Entradas recursivas usadas al crear un tipo complejo.
name	string	Nombre de la entrada.
source	string	Origen de la entrada.
sourceContext	string	Contexto de origen usado para seleccionar entradas recursivas.

KnowledgeAgent

Object

Nombre	Tipo	Description
@odata.etag	string	La ETag del agente.
description	string	Descripción del agente.
encryptionKey	SearchResourceEncryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para la definición de agente cuando se desea tener la seguridad total de que nadie, ni siquiera Microsoft, puede descifrarlos. Una vez que haya cifrado la definición del agente, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar la clave de cifrado; La definición del agente no se verá afectada. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios de pago creados el 1 de enero de 2019 o después.
models	KnowledgeAgentModel[]: KnowledgeAgentAzureOpenAIModel[]	Contiene opciones de configuración sobre cómo conectarse a modelos de IA.
name	string	El nombre del agente de conocimiento.
requestLimits	KnowledgeAgentRequestLimits	Barreras de protección para limitar la cantidad de recursos que se utilizan para una solicitud de recuperación de un solo agente.
targetIndexes	KnowledgeAgentTargetIndex[]

KnowledgeAgentAzureOpenAIModel

Object

Especifica el recurso de Azure OpenAI que se usa para realizar el planeamiento de consultas.

Nombre	Tipo	Description
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Contiene los parámetros específicos del punto de conexión del modelo de Azure OpenAI.
kind	string: azureOpenAI	El tipo de modelo de IA.

KnowledgeAgentModelKind

Enumeración

El modelo de IA que se usará para la planeación de consultas.

Valor	Description
azureOpenAI	Use modelos de Azure Open AI para el planeamiento de consultas.

KnowledgeAgentRequestLimits

Object

Barreras de protección para limitar la cantidad de recursos que se utilizan para una solicitud de recuperación de un solo agente.

Nombre	Tipo	Description
maxOutputSize	integer (int32)	Limita el tamaño máximo del contenido de la salida.
maxRuntimeInSeconds	integer (int32)	El tiempo de ejecución máximo en segundos.

KnowledgeAgentTargetIndex

Object

Nombre	Tipo	Description
defaultIncludeReferenceSourceData	boolean	Indica si se deben incluir los datos de origen de referencia.
defaultMaxDocsForReranker	integer (int32)	Limita el número de documentos considerados para la clasificación.
defaultRerankerThreshold	number (float) minimum: 0 maximum: 4	Un umbral para reclasificar los resultados (rango: 0-4).
indexName	string	Nombre del índice de destino.

ListKnowledgeAgentsResult

Object

Nombre	Tipo	Description
value	KnowledgeAgent[]

OutputFieldMappingEntry

Object

Asignación de campos de salida para una aptitud.

Nombre	Tipo	Description
name	string	Nombre de la salida definida por la aptitud.
targetName	string	Nombre de destino de la salida. Es opcional y tiene como valor predeterminado el nombre.

SearchIndexerDataNoneIdentity

Object

Borra la propiedad de identidad de un origen de datos.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragmento de URI que especifica el tipo de identidad.

SearchIndexerDataUserAssignedIdentity

Object

Especifica la identidad de un origen de datos que se va a usar.

Nombre	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragmento de URI que especifica el tipo de identidad.
userAssignedIdentity	string	El identificador de recurso de Azure completo de una identidad administrada asignada por el usuario normalmente con el formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que se debe haber asignado al servicio de búsqueda.

SearchResourceEncryptionKey

Object

Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que cree y administre se pueden usar para cifrar o descifrar datos en reposo, como índices y mapas de sinónimos.

Nombre	Tipo	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Credenciales opcionales de Azure Active Directory que se usan para acceder a Azure Key Vault. No es necesario si se usa la identidad administrada en su lugar.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Una identidad administrada explícita que se va a usar para esta clave de cifrado. Si no se especifica y la propiedad de credenciales de acceso es null, se usa la identidad administrada asignada por el sistema. Al actualizar al recurso, si la identidad explícita no está especificada, permanece sin cambios. Si se especifica "none", se borra el valor de esta propiedad.
keyVaultKeyName	string	Nombre de la clave de Azure Key Vault que se usará para cifrar los datos en reposo.
keyVaultKeyVersion	string	Versión de la clave de Azure Key Vault que se usará para cifrar los datos en reposo.
keyVaultUri	string	El URI de Azure Key Vault, también denominado nombre DNS, que contiene la clave que se va a usar para cifrar los datos en reposo. Un URI de ejemplo podría ser `https://my-keyvault-name.vault.azure.net`.

Compartir a través de

Knowledge Agents - List

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Ejemplos

SearchServiceListKnowledgeAgents

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AzureActiveDirectoryApplicationCredentials

AzureOpenAIEmbeddingSkill

AzureOpenAIModelName

AzureOpenAIParameters

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InputFieldMappingEntry

KnowledgeAgent

KnowledgeAgentAzureOpenAIModel

KnowledgeAgentModelKind

KnowledgeAgentRequestLimits

KnowledgeAgentTargetIndex

ListKnowledgeAgentsResult

OutputFieldMappingEntry

SearchIndexerDataNoneIdentity

SearchIndexerDataUserAssignedIdentity

SearchResourceEncryptionKey