Knowledge Sources - Get

Recupera una definición de origen de conocimiento.

GET {endpoint}/knowledgesources('{sourceName}')?api-version=2025-08-01-preview

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
path True

string

La dirección URL del punto de conexión del servicio de búsqueda.

sourceName
path True

string

El nombre del origen de conocimiento que se va a recuperar.

api-version
query True

string

Versión de la API del cliente.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-request-id

string (uuid)

El identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Respuestas

Nombre Tipo Description
200 OK KnowledgeSource:
Other Status Codes

ErrorResponse

Respuesta de error.

Ejemplos

SearchServiceGetKnowledgeSource
SearchServiceGetKnowledgeSourceAzureBlob

SearchServiceGetKnowledgeSource

Solicitud de ejemplo

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2025-08-01-preview

Respuesta de muestra

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataSelect": "description,category"
  }
}

SearchServiceGetKnowledgeSourceAzureBlob

Solicitud de ejemplo

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2025-08-01-preview

Respuesta de muestra

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "identity": {
      "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
      "userAssignedIdentity": "/my/userassigned/id"
    },
    "embeddingModel": {
      "name": "openai",
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com",
        "deploymentId": "model",
        "apiKey": "<redacted>",
        "modelName": "text-embedding-3-large"
      }
    },
    "chatCompletionModel": {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com",
        "deploymentId": "myDeployment",
        "apiKey": "<redacted>",
        "modelName": "gpt-4o-mini"
      }
    },
    "ingestionSchedule": {
      "interval": "P1D",
      "startTime": "2024-06-06T00:01:50.265Z"
    }
  }
}

Definiciones

Nombre Description
AIFoundryModelCatalogName

Nombre del modelo de inserción del catálogo de Azure AI Foundry al que se llamará.

AIServicesVisionParameters

Especifica los parámetros de AI Services Vision para vectorizar una imagen o texto de consulta.

AIServicesVisionVectorizer

Especifica los parámetros de AI Services Vision para vectorizar una imagen o texto de consulta.

AMLParameters

Especifica las propiedades para conectarse a un vectorizador AML.

AMLVectorizer

Especifica un punto de conexión de Azure Machine Learning implementado a través del catálogo de modelos de Azure AI Foundry para generar la inserción de vectores de una cadena de consulta.

AzureActiveDirectoryApplicationCredentials

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

AzureBlobKnowledgeSource

Configuración para el origen de conocimiento de Azure Blob Storage.

AzureBlobKnowledgeSourceParameters

Parámetros para el origen de conocimiento de Azure Blob Storage.

AzureOpenAIEmbeddingSkill

Permite generar una inserción vectorial 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.

AzureOpenAIVectorizer

Especifica el recurso de Azure OpenAI que se usa para vectorizar una cadena de consulta.

ErrorAdditionalInfo

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

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

IndexingSchedule

Representa una programación para la ejecución del indexador.

InputFieldMappingEntry

Asignación de campos de entrada para una aptitud.

KnowledgeAgentAzureOpenAIModel

Especifica el recurso de Azure OpenAI que se usa para realizar la planeación de consultas.

KnowledgeAgentModelKind

El modelo de IA que se utilizará para la planificación de consultas.

KnowledgeSourceKind

El tipo de fuente de conocimiento.

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 utilizar.

SearchIndexKnowledgeSource

Fuente de conocimiento dirigida a un índice de búsqueda.

SearchIndexKnowledgeSourceParameters

Parámetros para el origen de conocimiento del índice de búsqueda.

SearchResourceEncryptionKey

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

VectorSearchVectorizerKind

El método de vectorización que se utilizará durante el tiempo de consulta.

WebApiParameters

Especifica las propiedades para conectarse a un vectorizador definido por el usuario.

WebApiVectorizer

Especifica un vectorizador definido por el usuario para generar la incrustación vectorial de una cadena de consulta. La integración de un vectorizador externo se logra mediante la interfaz de API web personalizada de un conjunto de aptitudes.

AIFoundryModelCatalogName

Nombre del modelo de inserción del catálogo de Azure AI Foundry al que se llamará.

Valor Description
OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32
OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336
Facebook-DinoV2-Image-Embeddings-ViT-Base
Facebook-DinoV2-Image-Embeddings-ViT-Giant
Cohere-embed-v3-english
Cohere-embed-v3-multilingual
Cohere-embed-v4

Modelo de incrustación coherente v4 para generar incrustaciones tanto a partir de texto como de imágenes.

AIServicesVisionParameters

Especifica los parámetros de AI Services Vision para vectorizar una imagen o texto de consulta.

Nombre Tipo Description
apiKey

string

Clave de API del recurso de AI Services designado.

authIdentity SearchIndexerDataIdentity:

La identidad administrada asignada por el usuario que se usa para las conexiones salientes. Si se proporciona un authResourceId y no se especifica, se usa la identidad administrada asignada por el sistema. En las actualizaciones del índice, si no se especifica la identidad, el valor permanece sin cambios. Si se establece en "none", se borra el valor de esta propiedad.

modelVersion

string

La versión del modelo que se va a usar al llamar al servicio AI Services Vision. De forma predeterminada, se establecerá la última disponible cuando no se especifique.

resourceUri

string (uri)

El URI del recurso de AI Services.

AIServicesVisionVectorizer

Especifica los parámetros de AI Services Vision para vectorizar una imagen o texto de consulta.

Nombre Tipo Description
aiServicesVisionParameters

AIServicesVisionParameters

Contiene los parámetros específicos de la vectorización de incrustación de AI Services Vision.

kind string:

aiServicesVision

El nombre del tipo de método de vectorización que se configura para su uso con la búsqueda vectorial.

name

string

El nombre que se va a asociar con este método de vectorización en particular.

AMLParameters

Especifica las propiedades para conectarse a un vectorizador AML.

Nombre Tipo Description
key

string

(Necesario para la autenticación de claves) La clave para el servicio AML.

modelName

AIFoundryModelCatalogName

Nombre del modelo de inserción del catálogo de Azure AI Foundry que se implementa en el punto de conexión proporcionado.

region

string

(Opcional para la autenticación de tokens). La región en la que se implementa el servicio AML.

resourceId

string

(Necesario para la autenticación de tokens). El identificador de recurso de Azure Resource Manager del servicio AML. Debe tener el formato subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.

timeout

string (duration)

(Opcional) Cuando se especifica, indica el tiempo de espera para el cliente http que realiza la llamada API.

uri

string (uri)

(Necesario para la autenticación sin clave o sin autenticación) El URI de puntuación del servicio AML al que se enviará la carga JSON. Solo se permite el esquema de URI https.

AMLVectorizer

Especifica un punto de conexión de Azure Machine Learning implementado a través del catálogo de modelos de Azure AI Foundry para generar la inserción de vectores de una cadena de consulta.

Nombre Tipo Description
amlParameters

AMLParameters

Especifica las propiedades del vectorizador AML.

kind string:

aml

El nombre del tipo de método de vectorización que se configura para su uso con la búsqueda vectorial.

name

string

El nombre que se va a asociar con este método de vectorización en particular.

AzureActiveDirectoryApplicationCredentials

Credenciales de una aplicación registrada creada para el servicio de búsqueda, usadas 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 usará al cifrar los datos en reposo. El identificador de aplicación no debe confundirse con el identificador de objeto de la aplicación de AAD.

applicationSecret

string

Clave de autenticación de la aplicación de AAD especificada.

AzureBlobKnowledgeSource

Configuración para el origen de conocimiento de Azure Blob Storage.

Nombre Tipo Description
@odata.etag

string

La ETag del agente.

azureBlobParameters

AzureBlobKnowledgeSourceParameters

El tipo de fuente de conocimiento.

description

string

Descripción opcional definida por el usuario.

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 del agente cuando desea una garantía total de que nadie, ni siquiera Microsoft, puede descifrarlos. Una vez que haya cifrado la definición del agente, siempre permanecerá encriptada. 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 su clave de cifrado; La definición de su 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 pagos creados a partir del 1 de enero de 2019.

kind string:

azureBlob

El tipo de fuente de conocimiento.

name

string

El nombre de la fuente de conocimiento.

AzureBlobKnowledgeSourceParameters

Parámetros para el origen de conocimiento de Azure Blob Storage.

Nombre Tipo Description
chatCompletionModel KnowledgeAgentModel:

KnowledgeAgentAzureOpenAIModel

Modelo opcional de finalización de chat para la verbalización de imágenes o la extracción de contexto.

connectionString

string

Cadena de conexión basada en clave o el formato ResourceId si se usa una identidad administrada.

containerName

string

Nombre del contenedor de almacenamiento de blobs.

createdResources

object

Recursos creados por la fuente de conocimiento.

disableImageVerbalization

boolean

Indica si se debe desactivar la verbalización de la imagen.

embeddingModel VectorSearchVectorizer:

Configuración opcional del vectorizador para vectorizar contenido.

folderPath

string

Ruta de acceso de carpeta opcional dentro del contenedor.

identity SearchIndexerDataIdentity:

Una identidad explícita que se usará para este origen de conocimiento.

ingestionSchedule

IndexingSchedule

Programación opcional para la ingesta de datos.

AzureOpenAIEmbeddingSkill

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

Nombre Tipo Description
@odata.type string:

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

Un fragmento de URI que especifica el tipo de aptitud.

apiKey

string

Clave de API del recurso de Azure OpenAI designado.

authIdentity SearchIndexerDataIdentity:

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

La 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 text-embedding-3 y modelos posteriores.

inputs

InputFieldMappingEntry[]

Las entradas de las aptitudes pueden ser una columna en el conjunto de datos de origen o la salida de una aptitud ascendente.

modelName

AzureOpenAIModelName

Nombre del modelo de incrustación que se implementa en la ruta deploymentId proporcionada.

name

string

El nombre de la aptitud que la identifica de forma única dentro del conjunto de aptitudes. A una habilidad sin nombre definido se le asignará un nombre predeterminado de su índice basado en 1 en la matriz de habilidades, con el prefijo del carácter '#'.

outputs

OutputFieldMappingEntry[]

La salida de una aptitud es un campo de un índice de búsqueda o un valor que otra aptitud puede consumir como entrada.

resourceUri

string (uri)

URI del recurso de Azure OpenAI.

AzureOpenAIModelName

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

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

AzureOpenAIParameters

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:

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 incrustación que se implementa en la ruta deploymentId proporcionada.

resourceUri

string (uri)

URI del recurso de Azure OpenAI.

AzureOpenAIVectorizer

Especifica el recurso de Azure OpenAI que se usa para vectorizar una cadena de consulta.

Nombre Tipo Description
azureOpenAIParameters AzureOpenAIParameters:

AzureOpenAIEmbeddingSkill

Contiene los parámetros específicos de la vectorización de inserción de Azure OpenAI.

kind string:

azureOpenAI

El nombre del tipo de método de vectorización que se configura para su uso con la búsqueda vectorial.

name

string

El nombre que se va a asociar con este método de vectorización en particular.

ErrorAdditionalInfo

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

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Los detalles del error.

message

string

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

IndexingSchedule

Representa una programación para la ejecución del indexador.

Nombre Tipo Description
interval

string (duration)

Intervalo de tiempo entre ejecuciones del indexador.

startTime

string (date-time)

Hora en la que un indexador debe comenzar a ejecutarse.

InputFieldMappingEntry

Asignación de campos de entrada para una aptitud.

Nombre Tipo Description
inputs

InputFieldMappingEntry[]

Las entradas recursivas que se usan al crear un tipo complejo.

name

string

Nombre de la entrada.

source

string

El origen de la entrada.

sourceContext

string

El contexto de origen utilizado para seleccionar entradas recursivas.

KnowledgeAgentAzureOpenAIModel

Especifica el recurso de Azure OpenAI que se usa para realizar la planeación 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

El modelo de IA que se utilizará para la planificación de consultas.

Valor Description
azureOpenAI

Use modelos de Azure Open AI para la planeación de consultas.

KnowledgeSourceKind

El tipo de fuente de conocimiento.

Valor Description
searchIndex

Un origen de conocimiento que lee datos de un índice de búsqueda.

azureBlob

Un origen de conocimiento que lee e ingiere datos de Azure Blob Storage en un índice de búsqueda.

OutputFieldMappingEntry

Asignación de campos de salida para una aptitud.

Nombre Tipo Description
name

string

El nombre de la salida definida por la aptitud.

targetName

string

El nombre de destino de la salida. Es opcional y por defecto nombrar.

SearchIndexerDataNoneIdentity

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

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

Nombre Tipo Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Fragmento de URI que especifica el tipo de identidad.

userAssignedIdentity

string

Identificador de recurso completo de Azure 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 debería haberse asignado al servicio de búsqueda.

SearchIndexKnowledgeSource

Fuente de conocimiento dirigida a un índice de búsqueda.

Nombre Tipo Description
@odata.etag

string

La ETag del agente.

description

string

Descripción opcional definida por el usuario.

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 del agente cuando desea una garantía total de que nadie, ni siquiera Microsoft, puede descifrarlos. Una vez que haya cifrado la definición del agente, siempre permanecerá encriptada. 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 su clave de cifrado; La definición de su 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 pagos creados a partir del 1 de enero de 2019.

kind string:

searchIndex

El tipo de fuente de conocimiento.

name

string

El nombre de la fuente de conocimiento.

searchIndexParameters

SearchIndexKnowledgeSourceParameters

Los parámetros de la fuente de conocimiento.

SearchIndexKnowledgeSourceParameters

Parámetros para el origen de conocimiento del índice de búsqueda.

Nombre Tipo Description
searchIndexName

string

El nombre del índice de búsqueda.

sourceDataSelect

string

Se utiliza para solicitar campos adicionales para los datos de origen a los que se hace referencia.

SearchResourceEncryptionKey

Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que crea y administra 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 usadas para acceder a Azure Key Vault. No es necesario si se usa la identidad administrada en su lugar.

identity SearchIndexerDataIdentity:

Una identidad administrada explícita que se 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 el recurso, si no se especifica la identidad explícita, 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

La 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 conocido como nombre DNS, que contiene la clave que se usará para cifrar los datos en reposo. Un ejemplo de URI podría ser https://my-keyvault-name.vault.azure.net.

VectorSearchVectorizerKind

El método de vectorización que se utilizará durante el tiempo de consulta.

Valor Description
azureOpenAI

Genere incrustaciones mediante un recurso de Azure OpenAI en el momento de la consulta.

customWebApi

Genere incrustaciones mediante un punto de conexión web personalizado en el momento de la consulta.

aiServicesVision

Genere incrustaciones para una entrada de imagen o texto en el momento de la consulta mediante la API Vision Vectorize de Azure AI Services.

aml

Genere inserciones mediante un punto de conexión de Azure Machine Learning implementado a través del catálogo de modelos de Azure AI Foundry en el momento de la consulta.

WebApiParameters

Especifica las propiedades para conectarse a un vectorizador definido por el usuario.

Nombre Tipo Description
authIdentity SearchIndexerDataIdentity:

La identidad administrada asignada por el usuario que se usa para las conexiones salientes. Si se proporciona un authResourceId y no se especifica, se usa la identidad administrada asignada por el sistema. En las actualizaciones del indexador, si no se especifica la identidad, el valor permanece sin cambios. Si se establece en "none", se borra el valor de esta propiedad.

authResourceId

string

Se aplica a los puntos de conexión personalizados que se conectan a código externo en una función de Azure o alguna otra aplicación que proporcione las transformaciones. Este valor debe ser el identificador de aplicación creado para la función o aplicación cuando se registró en Azure Active Directory. Cuando se especifica, la vectorización se conecta a la función o aplicación mediante un identificador administrado (ya sea del sistema o asignado por el usuario) del servicio de búsqueda y el token de acceso de la función o aplicación, utilizando este valor como identificador de recurso para crear el ámbito del token de acceso.

httpHeaders

object

Los encabezados necesarios para realizar la solicitud HTTP.

httpMethod

string

El método para la solicitud HTTP.

timeout

string (duration)

El tiempo de espera deseado para la solicitud. El valor predeterminado es 30 segundos.

uri

string (uri)

El URI de la API web que proporciona el vectorizador.

WebApiVectorizer

Especifica un vectorizador definido por el usuario para generar la incrustación vectorial de una cadena de consulta. La integración de un vectorizador externo se logra mediante la interfaz de API web personalizada de un conjunto de aptitudes.

Nombre Tipo Description
customWebApiParameters

WebApiParameters

Especifica las propiedades del vectorizador definido por el usuario.

kind string:

customWebApi

El nombre del tipo de método de vectorización que se configura para su uso con la búsqueda vectorial.

name

string

El nombre que se va a asociar con este método de vectorización en particular.