Knowledge Sources - Create

Crée une nouvelle source de connaissances.

POST {endpoint}/knowledgesources?api-version=2025-08-01-preview

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
path True

string

URL du point de terminaison du service de recherche.

api-version
query True

string

Version de l’API client.

En-tête de la demande

Nom Obligatoire Type Description
x-ms-client-request-id

string (uuid)

ID de suivi envoyé avec la demande pour aider au débogage.

Corps de la demande

Le corps de la requête peut être l’un des suivants :

Nom Description
AzureBlobKnowledgeSource

Source de connaissances Configuration pour le stockage Blob Azure.

SearchIndexKnowledgeSource

Source de connaissances ciblant un index de recherche.

AzureBlobKnowledgeSource

Source de connaissances Configuration pour le stockage Blob Azure.

Nom Obligatoire Type Description
azureBlobParameters True

AzureBlobKnowledgeSourceParameters

Le type de source de connaissances.

kind True string:

azureBlob

Le type de source de connaissances.

name True

string

Nom de la source de connaissances.

@odata.etag

string

L’ETag de l’agent.

description

string

Description facultative définie par l’utilisateur.

encryptionKey

SearchResourceEncryptionKey

Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre agent lorsque vous voulez avoir l’assurance que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre agent, celle-ci reste toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; La définition de votre agent n’est pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.

SearchIndexKnowledgeSource

Source de connaissances ciblant un index de recherche.

Nom Obligatoire Type Description
kind True string:

searchIndex

Le type de source de connaissances.

name True

string

Nom de la source de connaissances.

searchIndexParameters True

SearchIndexKnowledgeSourceParameters

Paramètres de la source de connaissances.

@odata.etag

string

L’ETag de l’agent.

description

string

Description facultative définie par l’utilisateur.

encryptionKey

SearchResourceEncryptionKey

Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre agent lorsque vous voulez avoir l’assurance que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre agent, celle-ci reste toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; La définition de votre agent n’est pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.

Réponses

Nom Type Description
201 Created KnowledgeSource:

Création réussie d’une source de connaissances

Other Status Codes

ErrorResponse

Réponse d’erreur.

Exemples

SearchServiceCreateKnowledgeSource
SearchServiceCreateKnowledgeSourceAzureBlob

SearchServiceCreateKnowledgeSource

Exemple de requête

POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2025-08-01-preview


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

Exemple de réponse

{
  "@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"
  }
}

SearchServiceCreateKnowledgeSourceAzureBlob

Exemple de requête

POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2025-08-01-preview


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

Exemple de réponse

{
  "@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",
    "disableImageVerbalization": false,
    "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": "api-key",
        "modelName": "text-embedding-3-large"
      }
    },
    "chatCompletionModel": {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "myDeployment",
        "apiKey": "api-key",
        "modelName": "gpt-4o-mini"
      }
    },
    "ingestionSchedule": {
      "interval": "P1D",
      "startTime": "2024-06-06T00:01:50.265Z"
    }
  }
}

Définitions

Nom Description
AIFoundryModelCatalogName

Nom du modèle d’incorporation du catalogue Azure AI Foundry qui sera appelé.

AIServicesVisionParameters

Spécifie les paramètres AI Services Vision pour la vectorisation d’une image, d’une image ou d’un texte de requête.

AIServicesVisionVectorizer

Spécifie les paramètres AI Services Vision pour la vectorisation d’une image, d’une image ou d’un texte de requête.

AMLParameters

Spécifie les propriétés de connexion à un vectoriseur AML.

AMLVectorizer

Spécifie un point de terminaison Azure Machine Learning déployé via le catalogue de modèles Azure AI Foundry pour générer l’incorporation vectorielle d’une chaîne de requête.

AzureActiveDirectoryApplicationCredentials

Informations d’identification d’une application inscrite créée pour votre service de recherche, utilisée pour l’accès authentifié aux clés de chiffrement stockées dans Azure Key Vault.

AzureBlobKnowledgeSource

Source de connaissances Configuration pour le stockage Blob Azure.

AzureBlobKnowledgeSourceParameters

Source de connaissances Paramètres pour le stockage Blob Azure.

AzureOpenAIEmbeddingSkill

Vous permet de générer un incorporation vectorielle pour une entrée de texte donnée à l’aide de la ressource Azure OpenAI.

AzureOpenAIModelName

Nom du modèle Azure Open AI qui sera appelé.

AzureOpenAIParameters

Spécifie les paramètres de connexion à la ressource Azure OpenAI.

AzureOpenAIVectorizer

Spécifie la ressource Azure OpenAI utilisée pour vectoriser une chaîne de requête.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

IndexingSchedule

Représente une planification pour l’exécution de l’indexeur.

InputFieldMappingEntry

Mappage de champ de saisie pour une compétence.

KnowledgeAgentAzureOpenAIModel

Spécifie la ressource Azure OpenAI utilisée pour la planification des requêtes.

KnowledgeAgentModelKind

Le modèle d’IA à utiliser pour la planification des requêtes.

KnowledgeSourceKind

Le type de source de connaissance.

OutputFieldMappingEntry

Mappage de champ de sortie pour une compétence.

SearchIndexerDataNoneIdentity

Efface la propriété identity d’une source de données.

SearchIndexerDataUserAssignedIdentity

Spécifie l’identité d’une source de données à utiliser.

SearchIndexKnowledgeSource

Source de connaissances ciblant un index de recherche.

SearchIndexKnowledgeSourceParameters

Paramètres de la source de connaissances de l’index de recherche.

SearchResourceEncryptionKey

Clé de chiffrement gérée par le client dans Azure Key Vault. Les clés que vous créez et gérez peuvent être utilisées pour chiffrer ou déchiffrer des données au repos, telles que des index et des cartes de synonymes.

VectorSearchVectorizerKind

Méthode de vectorisation à utiliser au moment de la requête.

WebApiParameters

Spécifie les propriétés de connexion à un vectoriseur défini par l’utilisateur.

WebApiVectorizer

Spécifie un vectoriseur défini par l’utilisateur pour générer l’incorporation vectorielle d’une chaîne de requête. L’intégration d’un vectoriseur externe est réalisée à l’aide de l’interface API Web personnalisée d’un ensemble de compétences.

AIFoundryModelCatalogName

Nom du modèle d’incorporation du catalogue Azure AI Foundry qui sera appelé.

Valeur 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

Modèle Cohere embed v4 pour générer des plongements à partir de texte et d’images.

AIServicesVisionParameters

Spécifie les paramètres AI Services Vision pour la vectorisation d’une image, d’une image ou d’un texte de requête.

Nom Type Description
apiKey

string

Clé API de la ressource AI Services désignée.

authIdentity SearchIndexerDataIdentity:

Identité managée affectée par l’utilisateur utilisée pour les connexions sortantes. Si un authResourceId est fourni et qu’il n’est pas spécifié, l’identité managée affectée par le système est utilisée. Lors des mises à jour de l’index, si l’identité n’est pas spécifiée, la valeur reste inchangée. Si la valeur est « none », la valeur de cette propriété est effacée.

modelVersion

string

Version du modèle à utiliser lors de l’appel du service AI Services Vision. La valeur par défaut est la dernière disponible si elle n’est pas spécifiée.

resourceUri

string (uri)

URI de la ressource AI Services.

AIServicesVisionVectorizer

Spécifie les paramètres AI Services Vision pour la vectorisation d’une image, d’une image ou d’un texte de requête.

Nom Type Description
aiServicesVisionParameters

AIServicesVisionParameters

Contient les paramètres spécifiques à la vectorisation de l’incorporation de la vision des services d’IA.

kind string:

aiServicesVision

Nom du type de méthode de vectorisation configuré pour être utilisé avec la recherche vectorielle.

name

string

Nom à associer à cette méthode de vectorisation particulière.

AMLParameters

Spécifie les propriétés de connexion à un vectoriseur AML.

Nom Type Description
key

string

(Requis pour l’authentification par clé) La clé du service AML.

modelName

AIFoundryModelCatalogName

Nom du modèle d’incorporation du catalogue Azure AI Foundry qui est déployé au point de terminaison fourni.

region

string

(Facultatif pour l’authentification par jeton). Région dans laquelle le service AML est déployé.

resourceId

string

(Requis pour l’authentification par jeton). ID de ressource Azure Resource Manager du service AML. Il doit être au format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.

timeout

string (duration)

(Facultatif) Lorsqu’il est spécifié, indique le délai d’expiration du client http effectuant l’appel d’API.

uri

string (uri)

(Requis en cas d’absence d’authentification ou d’authentification par clé) URI de scoring du service AML auquel la charge utile JSON sera envoyée. Seul le schéma d’URI https est autorisé.

AMLVectorizer

Spécifie un point de terminaison Azure Machine Learning déployé via le catalogue de modèles Azure AI Foundry pour générer l’incorporation vectorielle d’une chaîne de requête.

Nom Type Description
amlParameters

AMLParameters

Spécifie les propriétés du vectoriseur AML.

kind string:

aml

Nom du type de méthode de vectorisation configuré pour être utilisé avec la recherche vectorielle.

name

string

Nom à associer à cette méthode de vectorisation particulière.

AzureActiveDirectoryApplicationCredentials

Informations d’identification d’une application inscrite créée pour votre service de recherche, utilisée pour l’accès authentifié aux clés de chiffrement stockées dans Azure Key Vault.

Nom Type Description
applicationId

string

ID d’application AAD qui a reçu les autorisations d’accès requises à Azure Key Vault à utiliser lors du chiffrement de vos données au repos. L’ID d’application ne doit pas être confondu avec l’ID d’objet de votre application AAD.

applicationSecret

string

Clé d’authentification de l’application AAD spécifiée.

AzureBlobKnowledgeSource

Source de connaissances Configuration pour le stockage Blob Azure.

Nom Type Description
@odata.etag

string

L’ETag de l’agent.

azureBlobParameters

AzureBlobKnowledgeSourceParameters

Le type de source de connaissances.

description

string

Description facultative définie par l’utilisateur.

encryptionKey

SearchResourceEncryptionKey

Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre agent lorsque vous voulez avoir l’assurance que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre agent, celle-ci reste toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; La définition de votre agent n’est pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.

kind string:

azureBlob

Le type de source de connaissances.

name

string

Nom de la source de connaissances.

AzureBlobKnowledgeSourceParameters

Source de connaissances Paramètres pour le stockage Blob Azure.

Nom Type Description
chatCompletionModel KnowledgeAgentModel:

KnowledgeAgentAzureOpenAIModel

Modèle de complétion de chat facultatif pour la verbalisation d’image ou l’extraction de contexte.

connectionString

string

Chaîne de connexion basée sur une clé ou au format ResourceId si vous utilisez une identité managée.

containerName

string

Nom du conteneur de stockage d’objets blob.

createdResources

object

Ressources créées par la source de connaissances.

disableImageVerbalization

boolean

Indique si la verbalisation de l’image doit être désactivée.

embeddingModel VectorSearchVectorizer:

Configuration facultative du vectoriseur pour la vectorisation du contenu.

folderPath

string

Chemin d’accès au dossier facultatif dans le conteneur.

identity SearchIndexerDataIdentity:

Une identité explicite à utiliser pour cette source de connaissances.

ingestionSchedule

IndexingSchedule

Planification facultative de l’ingestion des données.

AzureOpenAIEmbeddingSkill

Vous permet de générer un incorporation vectorielle pour une entrée de texte donnée à l’aide de la ressource Azure OpenAI.

Nom Type Description
@odata.type string:

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

Fragment d’URI spécifiant le type de compétence.

apiKey

string

Clé API de la ressource Azure OpenAI désignée.

authIdentity SearchIndexerDataIdentity:

Identité managée affectée par l’utilisateur utilisée pour les connexions sortantes.

context

string

Représente le niveau auquel les opérations ont lieu, tel que la racine du document ou le contenu du document (par exemple, /document ou /document/content). La valeur par défaut est /document.

deploymentId

string

ID du déploiement du modèle Azure OpenAI sur la ressource désignée.

description

string

Description de la compétence, qui décrit les entrées, les sorties et l’utilisation de la compétence.

dimensions

integer (int32)

Nombre de dimensions que les incorporations de sortie obtenues doivent avoir. Uniquement pris en charge dans text-embedding-3 et les modèles ultérieurs.

inputs

InputFieldMappingEntry[]

Les entrées des compétences peuvent être une colonne dans l’ensemble de données source ou la sortie d’une compétence en amont.

modelName

AzureOpenAIModelName

Nom du modèle d’incorporation déployé au chemin deploymentId fourni.

name

string

Nom de la compétence qui l’identifie de manière unique dans l’ensemble de compétences. Une compétence sans nom défini se verra attribuer un nom par défaut de son index de base 1 dans le tableau des compétences, préfixé par le caractère « # ».

outputs

OutputFieldMappingEntry[]

La sortie d’une compétence est soit un champ dans un index de recherche, soit une valeur qui peut être consommée en tant qu’entrée par une autre compétence.

resourceUri

string (uri)

URI de la ressource Azure OpenAI.

AzureOpenAIModelName

Nom du modèle Azure Open AI qui sera appelé.

Valeur 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

Spécifie les paramètres de connexion à la ressource Azure OpenAI.

Nom Type Description
apiKey

string

Clé API de la ressource Azure OpenAI désignée.

authIdentity SearchIndexerDataIdentity:

Identité managée affectée par l’utilisateur utilisée pour les connexions sortantes.

deploymentId

string

ID du déploiement du modèle Azure OpenAI sur la ressource désignée.

modelName

AzureOpenAIModelName

Nom du modèle d’incorporation déployé au chemin deploymentId fourni.

resourceUri

string (uri)

URI de la ressource Azure OpenAI.

AzureOpenAIVectorizer

Spécifie la ressource Azure OpenAI utilisée pour vectoriser une chaîne de requête.

Nom Type Description
azureOpenAIParameters AzureOpenAIParameters:

AzureOpenAIEmbeddingSkill

Contient les paramètres spécifiques à la vectorisation d’incorporation Azure OpenAI.

kind string:

azureOpenAI

Nom du type de méthode de vectorisation configuré pour être utilisé avec la recherche vectorielle.

name

string

Nom à associer à cette méthode de vectorisation particulière.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.

type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

IndexingSchedule

Représente une planification pour l’exécution de l’indexeur.

Nom Type Description
interval

string (duration)

Intervalle de temps entre les exécutions de l’indexeur.

startTime

string (date-time)

Heure à laquelle un indexeur doit commencer à s’exécuter.

InputFieldMappingEntry

Mappage de champ de saisie pour une compétence.

Nom Type Description
inputs

InputFieldMappingEntry[]

Entrées récursives utilisées lors de la création d’un type complexe.

name

string

Nom de l’entrée.

source

string

Source de l’entrée.

sourceContext

string

Contexte source utilisé pour la sélection des entrées récursives.

KnowledgeAgentAzureOpenAIModel

Spécifie la ressource Azure OpenAI utilisée pour la planification des requêtes.

Nom Type Description
azureOpenAIParameters AzureOpenAIParameters:

AzureOpenAIEmbeddingSkill

Contient les paramètres spécifiques au point de terminaison du modèle Azure OpenAI.

kind string:

azureOpenAI

Le type de modèle d’IA.

KnowledgeAgentModelKind

Le modèle d’IA à utiliser pour la planification des requêtes.

Valeur Description
azureOpenAI

Utilisez les modèles Azure Open AI pour la planification des requêtes.

KnowledgeSourceKind

Le type de source de connaissance.

Valeur Description
searchIndex

Source de connaissances qui lit les données d’un index de recherche.

azureBlob

Source de connaissances qui lit et ingère des données de Stockage Blob Azure dans un index de recherche.

OutputFieldMappingEntry

Mappage de champ de sortie pour une compétence.

Nom Type Description
name

string

Nom de la sortie défini par la compétence.

targetName

string

Nom cible de la sortie. Il est facultatif et nomme par défaut.

SearchIndexerDataNoneIdentity

Efface la propriété identity d’une source de données.

Nom Type Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Fragment d’URI spécifiant le type d’identité.

SearchIndexerDataUserAssignedIdentity

Spécifie l’identité d’une source de données à utiliser.

Nom Type Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Fragment d’URI spécifiant le type d’identité.

userAssignedIdentity

string

ID de ressource Azure complet d’un utilisateur affecté à une identité managée, généralement sous la forme « /subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId » qui aurait dû être attribué au service de recherche.

SearchIndexKnowledgeSource

Source de connaissances ciblant un index de recherche.

Nom Type Description
@odata.etag

string

L’ETag de l’agent.

description

string

Description facultative définie par l’utilisateur.

encryptionKey

SearchResourceEncryptionKey

Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre agent lorsque vous voulez avoir l’assurance que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre agent, celle-ci reste toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; La définition de votre agent n’est pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.

kind string:

searchIndex

Le type de source de connaissances.

name

string

Nom de la source de connaissances.

searchIndexParameters

SearchIndexKnowledgeSourceParameters

Paramètres de la source de connaissances.

SearchIndexKnowledgeSourceParameters

Paramètres de la source de connaissances de l’index de recherche.

Nom Type Description
searchIndexName

string

Nom de l’index de recherche.

sourceDataSelect

string

Permet de demander des champs supplémentaires pour les données sources référencées.

SearchResourceEncryptionKey

Clé de chiffrement gérée par le client dans Azure Key Vault. Les clés que vous créez et gérez peuvent être utilisées pour chiffrer ou déchiffrer des données au repos, telles que des index et des cartes de synonymes.

Nom Type Description
accessCredentials

AzureActiveDirectoryApplicationCredentials

Informations d’identification Azure Active Directory facultatives utilisées pour accéder à votre coffre de clés Azure. Non requis si vous utilisez l’identité managée à la place.

identity SearchIndexerDataIdentity:

Identité managée explicite à utiliser pour cette clé de chiffrement. S’il n’est pas spécifié et que la propriété d’informations d’identification d’accès est nulle, l’identité managée affectée par le système est utilisée. Lors de la mise à jour de la ressource, si l’identité explicite n’est pas spécifiée, elle reste inchangée. Si « none » est spécifié, la valeur de cette propriété est effacée.

keyVaultKeyName

string

Nom de votre clé Azure Key Vault à utiliser pour chiffrer vos données au repos.

keyVaultKeyVersion

string

Version de votre clé Azure Key Vault à utiliser pour chiffrer vos données au repos.

keyVaultUri

string

URI de votre Azure Key Vault, également appelé nom DNS, qui contient la clé à utiliser pour chiffrer vos données au repos. Un exemple d’URI pourrait être https://my-keyvault-name.vault.azure.net.

VectorSearchVectorizerKind

Méthode de vectorisation à utiliser au moment de la requête.

Valeur Description
azureOpenAI

Générez des intégrations à l’aide d’une ressource Azure OpenAI au moment de la requête.

customWebApi

Générez des intégrations à l’aide d’un point de terminaison web personnalisé au moment de la requête.

aiServicesVision

Générez des intégrations pour une entrée d’image ou de texte au moment de la requête à l’aide de l’API Vision Vectorize d’Azure AI Services.

aml

Générez des intégrations à l’aide d’un point de terminaison Azure Machine Learning déployé via le catalogue de modèles Azure AI Foundry au moment de la requête.

WebApiParameters

Spécifie les propriétés de connexion à un vectoriseur défini par l’utilisateur.

Nom Type Description
authIdentity SearchIndexerDataIdentity:

Identité managée affectée par l’utilisateur utilisée pour les connexions sortantes. Si un authResourceId est fourni et qu’il n’est pas spécifié, l’identité managée affectée par le système est utilisée. Lors des mises à jour de l’indexeur, si l’identité n’est pas spécifiée, la valeur reste inchangée. Si la valeur est « none », la valeur de cette propriété est effacée.

authResourceId

string

S’applique aux points de terminaison personnalisés qui se connectent à du code externe dans une fonction Azure ou une autre application qui fournit les transformations. Cette valeur doit être l’ID d’application créé pour la fonction ou l’application lors de son inscription auprès d’Azure Active Directory. Lorsqu’elle est spécifiée, la vectorisation se connecte à la fonction ou à l’application à l’aide d’un ID managé (attribué par le système ou par l’utilisateur) du service de recherche et du jeton d’accès de la fonction ou de l’application, en utilisant cette valeur comme ID de ressource pour la création de l’étendue du jeton d’accès.

httpHeaders

object

Les en-têtes nécessaires pour effectuer la requête HTTP.

httpMethod

string

Méthode de la requête HTTP.

timeout

string (duration)

Délai d’expiration souhaité pour la demande. La valeur par défaut est de 30 secondes.

uri

string (uri)

URI de l’API Web fournissant le vectoriseur.

WebApiVectorizer

Spécifie un vectoriseur défini par l’utilisateur pour générer l’incorporation vectorielle d’une chaîne de requête. L’intégration d’un vectoriseur externe est réalisée à l’aide de l’interface API Web personnalisée d’un ensemble de compétences.

Nom Type Description
customWebApiParameters

WebApiParameters

Spécifie les propriétés du vectoriseur défini par l’utilisateur.

kind string:

customWebApi

Nom du type de méthode de vectorisation configuré pour être utilisé avec la recherche vectorielle.

name

string

Nom à associer à cette méthode de vectorisation particulière.