Knowledge Sources - Create

Cria uma nova fonte de conhecimento.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string

A URL do ponto de extremidade do serviço de pesquisa.

api-version
query True

string

Versão da API do cliente.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
x-ms-client-request-id

string (uuid)

O ID de rastreamento enviado com a solicitação para ajudar na depuração.

Corpo da solicitação

O corpo da solicitação pode ser um dos seguintes:

Nome Description
AzureBlobKnowledgeSource

Configuração para a fonte de conhecimento do Armazenamento de Blobs do Azure.

SearchIndexKnowledgeSource

Fonte de conhecimento direcionada a um índice de pesquisa.

AzureBlobKnowledgeSource

Configuração para a fonte de conhecimento do Armazenamento de Blobs do Azure.

Nome Obrigatório Tipo Description
azureBlobParameters True

AzureBlobKnowledgeSourceParameters

O tipo da fonte de conhecimento.

kind True string:

azureBlob

O tipo da fonte de conhecimento.

name True

string

O nome da fonte de conhecimento.

@odata.etag

string

A ETag do agente.

description

string

Descrição opcional definida pelo usuário.

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição do agente quando você deseja garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografá-los. Depois de criptografar sua definição de agente, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de agente não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados a partir de 1º de janeiro de 2019.

SearchIndexKnowledgeSource

Fonte de conhecimento direcionada a um índice de pesquisa.

Nome Obrigatório Tipo Description
kind True string:

searchIndex

O tipo da fonte de conhecimento.

name True

string

O nome da fonte de conhecimento.

searchIndexParameters True

SearchIndexKnowledgeSourceParameters

Os parâmetros para a fonte de conhecimento.

@odata.etag

string

A ETag do agente.

description

string

Descrição opcional definida pelo usuário.

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição do agente quando você deseja garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografá-los. Depois de criptografar sua definição de agente, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de agente não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados a partir de 1º de janeiro de 2019.

Respostas

Nome Tipo Description
201 Created KnowledgeSource:

Criou com êxito uma fonte de conhecimento

Other Status Codes

ErrorResponse

Resposta de erro.

Exemplos

SearchServiceCreateKnowledgeSource
SearchServiceCreateKnowledgeSourceAzureBlob

SearchServiceCreateKnowledgeSource

Solicitação de exemplo

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

Resposta de exemplo

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

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
AIFoundryModelCatalogName

O nome do modelo de inserção do Catálogo do Azure AI Foundry que será chamado.

AIServicesVisionParameters

Especifica os parâmetros do AI Services Vision para vetorizar uma imagem ou texto de consulta.

AIServicesVisionVectorizer

Especifica os parâmetros do AI Services Vision para vetorizar uma imagem ou texto de consulta.

AMLParameters

Especifica as propriedades para se conectar a um vetorizador AML.

AMLVectorizer

Especifica um ponto de extremidade do Azure Machine Learning implantado por meio do Catálogo de Modelos do Azure AI Foundry para gerar a inserção vetorial de uma cadeia de caracteres de consulta.

AzureActiveDirectoryApplicationCredentials

Credenciais de um aplicativo registrado criado para o serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Azure Key Vault.

AzureBlobKnowledgeSource

Configuração para a fonte de conhecimento do Armazenamento de Blobs do Azure.

AzureBlobKnowledgeSourceParameters

Parâmetros para a fonte de conhecimento do Armazenamento de Blobs do Azure.

AzureOpenAIEmbeddingSkill

Permite gerar uma inserção de vetor para uma determinada entrada de texto usando o recurso OpenAI do Azure.

AzureOpenAIModelName

O nome do modelo do Azure Open AI que será chamado.

AzureOpenAIParameters

Especifica os parâmetros para se conectar ao recurso OpenAI do Azure.

AzureOpenAIVectorizer

Especifica o recurso OpenAI do Azure usado para vetorizar uma cadeia de caracteres de consulta.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

IndexingSchedule

Representa um agendamento para a execução do indexador.

InputFieldMappingEntry

Mapeamento de campo de entrada para uma habilidade.

KnowledgeAgentAzureOpenAIModel

Especifica o recurso OpenAI do Azure usado para fazer o planejamento de consulta.

KnowledgeAgentModelKind

O modelo de IA a ser usado para planejamento de consulta.

KnowledgeSourceKind

O tipo de fonte de conhecimento.

OutputFieldMappingEntry

Mapeamento de campo de saída para uma habilidade.

SearchIndexerDataNoneIdentity

Limpa a propriedade de identidade de uma fonte de dados.

SearchIndexerDataUserAssignedIdentity

Especifica a identidade de uma fonte de dados a ser usada.

SearchIndexKnowledgeSource

Fonte de conhecimento direcionada a um índice de pesquisa.

SearchIndexKnowledgeSourceParameters

Parâmetros para a fonte de conhecimento do índice de pesquisa.

SearchResourceEncryptionKey

Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.

VectorSearchVectorizerKind

O método de vetorização a ser usado durante o tempo de consulta.

WebApiParameters

Especifica as propriedades para se conectar a um vetorizador definido pelo usuário.

WebApiVectorizer

Especifica um vetorizador definido pelo usuário para gerar a incorporação vetorial de uma cadeia de caracteres de consulta. A integração de um vetorizador externo é obtida usando a interface de API Web personalizada de um conjunto de habilidades.

AIFoundryModelCatalogName

O nome do modelo de inserção do Catálogo do Azure AI Foundry que será chamado.

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 Cohere embed v4 para gerar incorporações de texto e imagens.

AIServicesVisionParameters

Especifica os parâmetros do AI Services Vision para vetorizar uma imagem ou texto de consulta.

Nome Tipo Description
apiKey

string

Chave de API do recurso de serviços de IA designado.

authIdentity SearchIndexerDataIdentity:

A identidade gerenciada atribuída pelo usuário usada para conexões de saída. Se um authResourceId for fornecido e não for especificado, a identidade gerenciada atribuída pelo sistema será usada. Nas atualizações do índice, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo.

modelVersion

string

A versão do modelo a ser usada ao chamar o serviço de Visão dos Serviços de IA. O padrão será o mais recente disponível quando não especificado.

resourceUri

string (uri)

O URI do recurso de Serviços de IA.

AIServicesVisionVectorizer

Especifica os parâmetros do AI Services Vision para vetorizar uma imagem ou texto de consulta.

Nome Tipo Description
aiServicesVisionParameters

AIServicesVisionParameters

Contém os parâmetros específicos para a vetorização de inserção do AI Services Vision.

kind string:

aiServicesVision

O nome do tipo de método de vetorização que está sendo configurado para uso com a pesquisa vetorial.

name

string

O nome a ser associado a esse método de vetorização específico.

AMLParameters

Especifica as propriedades para se conectar a um vetorizador AML.

Nome Tipo Description
key

string

(Necessário para autenticação de chave) A chave para o serviço AML.

modelName

AIFoundryModelCatalogName

O nome do modelo de inserção do Catálogo do Azure AI Foundry implantado no ponto de extremidade fornecido.

region

string

(Opcional para autenticação de token). A região em que o serviço AML é implantado.

resourceId

string

(Necessário para autenticação de token). A ID de recurso do Azure Resource Manager do serviço AML. Ele deve estar no formato subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.

timeout

string (duration)

(Opcional) Quando especificado, indica o tempo limite para o cliente http que faz a chamada à API.

uri

string (uri)

(Necessário para nenhuma autenticação ou autenticação de chave) O URI de pontuação do serviço AML para o qual a carga JSON será enviada. Somente o esquema de URI https é permitido.

AMLVectorizer

Especifica um ponto de extremidade do Azure Machine Learning implantado por meio do Catálogo de Modelos do Azure AI Foundry para gerar a inserção vetorial de uma cadeia de caracteres de consulta.

Nome Tipo Description
amlParameters

AMLParameters

Especifica as propriedades do vetorizador AML.

kind string:

aml

O nome do tipo de método de vetorização que está sendo configurado para uso com a pesquisa vetorial.

name

string

O nome a ser associado a esse método de vetorização específico.

AzureActiveDirectoryApplicationCredentials

Credenciais de um aplicativo registrado criado para o serviço de pesquisa, usado para acesso autenticado às chaves de criptografia armazenadas no Azure Key Vault.

Nome Tipo Description
applicationId

string

Uma ID de Aplicativo do AAD que recebeu as permissões de acesso necessárias ao Azure Key Vault que deve ser usado ao criptografar seus dados em repouso. A ID do Aplicativo não deve ser confundida com a ID do Objeto do Aplicativo AAD.

applicationSecret

string

A chave de autenticação do aplicativo AAD especificado.

AzureBlobKnowledgeSource

Configuração para a fonte de conhecimento do Armazenamento de Blobs do Azure.

Nome Tipo Description
@odata.etag

string

A ETag do agente.

azureBlobParameters

AzureBlobKnowledgeSourceParameters

O tipo da fonte de conhecimento.

description

string

Descrição opcional definida pelo usuário.

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição do agente quando você deseja garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografá-los. Depois de criptografar sua definição de agente, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de agente não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados a partir de 1º de janeiro de 2019.

kind string:

azureBlob

O tipo da fonte de conhecimento.

name

string

O nome da fonte de conhecimento.

AzureBlobKnowledgeSourceParameters

Parâmetros para a fonte de conhecimento do Armazenamento de Blobs do Azure.

Nome Tipo Description
chatCompletionModel KnowledgeAgentModel:

KnowledgeAgentAzureOpenAIModel

Modelo opcional de conclusão de bate-papo para verbalização de imagem ou extração de contexto.

connectionString

string

Cadeia de conexão baseada em chave ou no formato ResourceId se estiver usando uma identidade gerenciada.

containerName

string

O nome do contêiner de armazenamento de blobs.

createdResources

object

Recursos criados pela fonte de conhecimento.

disableImageVerbalization

boolean

Indica se a verbalização da imagem deve ser desativada.

embeddingModel VectorSearchVectorizer:

Configuração de vetorizador opcional para vetorizar conteúdo.

folderPath

string

Caminho de pasta opcional dentro do contêiner.

identity SearchIndexerDataIdentity:

Uma identidade explícita a ser usada para essa fonte de conhecimento.

ingestionSchedule

IndexingSchedule

Agendamento opcional para ingestão de dados.

AzureOpenAIEmbeddingSkill

Permite gerar uma inserção de vetor para uma determinada entrada de texto usando o recurso OpenAI do Azure.

Nome Tipo Description
@odata.type string:

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

Um fragmento de URI especificando o tipo de habilidade.

apiKey

string

Chave de API do recurso OpenAI do Azure designado.

authIdentity SearchIndexerDataIdentity:

A identidade gerenciada atribuída pelo usuário usada para conexões de saída.

context

string

Representa o nível em que as operações ocorrem, como a raiz do documento ou o conteúdo do documento (por exemplo, /document ou /document/content). O padrão é /document.

deploymentId

string

ID da implantação do modelo OpenAI do Azure no recurso designado.

description

string

A descrição da habilidade que descreve as entradas, saídas e uso da habilidade.

dimensions

integer (int32)

O número de dimensões que as inserções de saída resultantes devem ter. Compatível apenas com text-embedding-3 e modelos posteriores.

inputs

InputFieldMappingEntry[]

As entradas das habilidades podem ser uma coluna no conjunto de dados de origem ou a saída de uma habilidade upstream.

modelName

AzureOpenAIModelName

O nome do modelo de inserção implantado no caminho deploymentId fornecido.

name

string

O nome da habilidade que a identifica exclusivamente no conjunto de habilidades. Uma habilidade sem nome definido receberá um nome padrão de seu índice baseado em 1 na matriz de habilidades, prefixado com o caractere '#'.

outputs

OutputFieldMappingEntry[]

A saída de uma habilidade é um campo em um índice de pesquisa ou um valor que pode ser consumido como uma entrada por outra habilidade.

resourceUri

string (uri)

O URI do recurso OpenAI do Azure.

AzureOpenAIModelName

O nome do modelo do Azure Open AI que será chamado.

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 os parâmetros para se conectar ao recurso OpenAI do Azure.

Nome Tipo Description
apiKey

string

Chave de API do recurso OpenAI do Azure designado.

authIdentity SearchIndexerDataIdentity:

A identidade gerenciada atribuída pelo usuário usada para conexões de saída.

deploymentId

string

ID da implantação do modelo OpenAI do Azure no recurso designado.

modelName

AzureOpenAIModelName

O nome do modelo de inserção implantado no caminho deploymentId fornecido.

resourceUri

string (uri)

O URI do recurso OpenAI do Azure.

AzureOpenAIVectorizer

Especifica o recurso OpenAI do Azure usado para vetorizar uma cadeia de caracteres de consulta.

Nome Tipo Description
azureOpenAIParameters AzureOpenAIParameters:

AzureOpenAIEmbeddingSkill

Contém os parâmetros específicos para a vetorização de inserção do OpenAI do Azure.

kind string:

azureOpenAI

O nome do tipo de método de vetorização que está sendo configurado para uso com a pesquisa vetorial.

name

string

O nome a ser associado a esse método de vetorização específico.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código do erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

IndexingSchedule

Representa um agendamento para a execução do indexador.

Nome Tipo Description
interval

string (duration)

O intervalo de tempo entre as execuções do indexador.

startTime

string (date-time)

A hora em que um indexador deve começar a ser executado.

InputFieldMappingEntry

Mapeamento de campo de entrada para uma habilidade.

Nome Tipo Description
inputs

InputFieldMappingEntry[]

As entradas recursivas usadas ao criar um tipo complexo.

name

string

O nome da entrada.

source

string

A origem da entrada.

sourceContext

string

O contexto de origem usado para selecionar entradas recursivas.

KnowledgeAgentAzureOpenAIModel

Especifica o recurso OpenAI do Azure usado para fazer o planejamento de consulta.

Nome Tipo Description
azureOpenAIParameters AzureOpenAIParameters:

AzureOpenAIEmbeddingSkill

Contém os parâmetros específicos do ponto de extremidade do modelo OpenAI do Azure.

kind string:

azureOpenAI

O tipo de modelo de IA.

KnowledgeAgentModelKind

O modelo de IA a ser usado para planejamento de consulta.

Valor Description
azureOpenAI

Use modelos de IA aberta do Azure para planejamento de consulta.

KnowledgeSourceKind

O tipo de fonte de conhecimento.

Valor Description
searchIndex

Uma fonte de conhecimento que lê dados de um Índice de Pesquisa.

azureBlob

Uma fonte de conhecimento que lê e ingere dados do Armazenamento de Blobs do Azure em um Índice de Pesquisa.

OutputFieldMappingEntry

Mapeamento de campo de saída para uma habilidade.

Nome Tipo Description
name

string

O nome da saída definida pela habilidade.

targetName

string

O nome de destino da saída. É opcional e o nome é padrão.

SearchIndexerDataNoneIdentity

Limpa a propriedade de identidade de uma fonte de dados.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Um fragmento de URI especificando o tipo de identidade.

SearchIndexerDataUserAssignedIdentity

Especifica a identidade de uma fonte de dados a ser usada.

Nome Tipo Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Um fragmento de URI especificando o tipo de identidade.

userAssignedIdentity

string

A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída pelo usuário, normalmente no formato "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa.

SearchIndexKnowledgeSource

Fonte de conhecimento direcionada a um índice de pesquisa.

Nome Tipo Description
@odata.etag

string

A ETag do agente.

description

string

Descrição opcional definida pelo usuário.

encryptionKey

SearchResourceEncryptionKey

Uma descrição de uma chave de criptografia que você cria no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para a definição do agente quando você deseja garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografá-los. Depois de criptografar sua definição de agente, ela sempre permanecerá criptografada. O serviço de pesquisa ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Sua definição de agente não será afetada. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados a partir de 1º de janeiro de 2019.

kind string:

searchIndex

O tipo da fonte de conhecimento.

name

string

O nome da fonte de conhecimento.

searchIndexParameters

SearchIndexKnowledgeSourceParameters

Os parâmetros para a fonte de conhecimento.

SearchIndexKnowledgeSourceParameters

Parâmetros para a fonte de conhecimento do índice de pesquisa.

Nome Tipo Description
searchIndexName

string

O nome do índice de pesquisa.

sourceDataSelect

string

Usado para solicitar campos adicionais para dados de origem referenciados.

SearchResourceEncryptionKey

Uma chave de criptografia gerenciada pelo cliente no Azure Key Vault. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.

Nome Tipo Description
accessCredentials

AzureActiveDirectoryApplicationCredentials

Credenciais opcionais do Azure Active Directory usadas para acessar o Azure Key Vault. Não é necessário se estiver usando a identidade gerenciada.

identity SearchIndexerDataIdentity:

Uma identidade gerenciada explícita a ser usada para essa chave de criptografia. Se não for especificado e a propriedade de credenciais de acesso for nula, a identidade gerenciada atribuída pelo sistema será usada. Na atualização do recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "none" for especificado, o valor dessa propriedade será limpo.

keyVaultKeyName

string

O nome da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.

keyVaultKeyVersion

string

A versão da chave do Azure Key Vault a ser usada para criptografar seus dados em repouso.

keyVaultUri

string

O URI do Azure Key Vault, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um exemplo de URI pode ser https://my-keyvault-name.vault.azure.net.

VectorSearchVectorizerKind

O método de vetorização a ser usado durante o tempo de consulta.

Valor Description
azureOpenAI

Gere inserções usando um recurso do OpenAI do Azure no momento da consulta.

customWebApi

Gere inserções usando um ponto de extremidade da Web personalizado no momento da consulta.

aiServicesVision

Gere inserções para uma entrada de imagem ou texto no momento da consulta usando a API de Vetorização de Visão dos Serviços de IA do Azure.

aml

Gere inserções usando um ponto de extremidade do Azure Machine Learning implantado por meio do Catálogo de Modelos do Azure AI Foundry no momento da consulta.

WebApiParameters

Especifica as propriedades para se conectar a um vetorizador definido pelo usuário.

Nome Tipo Description
authIdentity SearchIndexerDataIdentity:

A identidade gerenciada atribuída pelo usuário usada para conexões de saída. Se um authResourceId for fornecido e não for especificado, a identidade gerenciada atribuída pelo sistema será usada. Nas atualizações do indexador, se a identidade não for especificada, o valor permanecerá inalterado. Se definido como "nenhum", o valor dessa propriedade será limpo.

authResourceId

string

Aplica-se a pontos de extremidade personalizados que se conectam ao código externo em uma função do Azure ou em algum outro aplicativo que fornece as transformações. Esse valor deve ser a ID do aplicativo criada para a função ou aplicativo quando ele foi registrado no Azure Active Directory. Quando especificada, a vetorização se conecta à função ou ao aplicativo usando uma ID gerenciada (atribuída pelo sistema ou pelo usuário) do serviço de pesquisa e o token de acesso da função ou do aplicativo, usando esse valor como a ID do recurso para criar o escopo do token de acesso.

httpHeaders

object

Os cabeçalhos necessários para fazer a solicitação HTTP.

httpMethod

string

O método para a solicitação HTTP.

timeout

string (duration)

O tempo limite desejado para a solicitação. O padrão é 30 segundos.

uri

string (uri)

O URI da API Web que fornece o vetorizador.

WebApiVectorizer

Especifica um vetorizador definido pelo usuário para gerar a incorporação vetorial de uma cadeia de caracteres de consulta. A integração de um vetorizador externo é obtida usando a interface de API Web personalizada de um conjunto de habilidades.

Nome Tipo Description
customWebApiParameters

WebApiParameters

Especifica as propriedades do vetorizador definido pelo usuário.

kind string:

customWebApi

O nome do tipo de método de vetorização que está sendo configurado para uso com a pesquisa vetorial.

name

string

O nome a ser associado a esse método de vetorização específico.