Knowledge Sources - Create

Usługa:: Search Service

Wersja interfejsu API:: 2025-08-01-preview

Tworzy nowe źródło wiedzy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Identyfikator śledzenia wysłany z żądaniem, aby pomóc w debugowaniu.

Treść żądania

Treść żądania może być jedną z następujących:

Nazwa	Opis
AzureBlobKnowledgeSource	Konfiguracja źródła wiedzy Azure Blob Storage.
SearchIndexKnowledgeSource	Źródło wiedzy przeznaczone dla indeksu wyszukiwania.

AzureBlobKnowledgeSource

Konfiguracja źródła wiedzy Azure Blob Storage.

Nazwa	Wymagane	Typ	Opis
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	Typ źródła wiedzy.
kind	True	string: azureBlob	Typ źródła wiedzy.
name	True	string	Nazwa źródła wiedzy.
@odata.etag		string	Element ETag agenta.
description		string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey		SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz jest używany w celu zapewnienia dodatkowego poziomu szyfrowania magazynowanych dla definicji agenta, gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może ich odszyfrować. Po zaszyfrowaniu definicji agenta zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość zgodnie z potrzebami, jeśli chcesz obrócić klucz szyfrowania; Nie będzie to miało wpływu na definicję agenta. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne w przypadku bezpłatnych usług wyszukiwania i jest dostępne tylko w przypadku płatnych usług utworzonych 1 stycznia 2019 r. lub później.

SearchIndexKnowledgeSource

Źródło wiedzy przeznaczone dla indeksu wyszukiwania.

Nazwa	Wymagane	Typ	Opis
kind	True	string: searchIndex	Typ źródła wiedzy.
name	True	string	Nazwa źródła wiedzy.
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	Parametry źródła wiedzy.
@odata.etag		string	Element ETag agenta.
description		string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey		SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz jest używany w celu zapewnienia dodatkowego poziomu szyfrowania magazynowanych dla definicji agenta, gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może ich odszyfrować. Po zaszyfrowaniu definicji agenta zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość zgodnie z potrzebami, jeśli chcesz obrócić klucz szyfrowania; Nie będzie to miało wpływu na definicję agenta. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne w przypadku bezpłatnych usług wyszukiwania i jest dostępne tylko w przypadku płatnych usług utworzonych 1 stycznia 2019 r. lub później.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	KnowledgeSource: SearchIndexKnowledgeSource AzureBlobKnowledgeSource	Pomyślnie utworzono źródło wiedzy
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchServiceCreateKnowledgeSource

SearchServiceCreateKnowledgeSourceAzureBlob

SearchServiceCreateKnowledgeSource

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 201

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

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 201

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

Definicje

Nazwa	Opis
AIFoundryModelCatalogName	Nazwa modelu osadzania z wykazu usługi Azure AI Foundry, który zostanie wywołany.
AIServicesVisionParameters	Określa parametry AI Services Vision do wektoryzacji obrazu lub tekstu zapytania.
AIServicesVisionVectorizer	Określa parametry AI Services Vision do wektoryzacji obrazu lub tekstu zapytania.
AMLParameters	Określa właściwości nawiązywania połączenia z wektoryzatorem AML.
AMLVectorizer	Określa punkt końcowy usługi Azure Machine Learning wdrożony za pośrednictwem wykazu modeli usługi Azure AI Foundry w celu wygenerowania osadzania wektora ciągu zapytania.
AzureActiveDirectoryApplicationCredentials	Poświadczenia zarejestrowanej aplikacji utworzonej dla usługi wyszukiwania, używanej do uwierzytelnionego dostępu do kluczy szyfrowania przechowywanych w usłudze Azure Key Vault.
AzureBlobKnowledgeSource	Konfiguracja źródła wiedzy Azure Blob Storage.
AzureBlobKnowledgeSourceParameters	Parametry źródła wiedzy Azure Blob Storage.
AzureOpenAIEmbeddingSkill	Umożliwia wygenerowanie osadzania wektora dla danego tekstu wejściowego przy użyciu zasobu usługi Azure OpenAI.
AzureOpenAIModelName	Nazwa modelu Azure Open AI, który zostanie wywołany.
AzureOpenAIParameters	Określa parametry nawiązywania połączenia z zasobem usługi Azure OpenAI.
AzureOpenAIVectorizer	Określa zasób usługi Azure OpenAI używany do wektoryzacji ciągu zapytania.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
IndexingSchedule	Reprezentuje harmonogram wykonywania indeksatora.
InputFieldMappingEntry	Mapowanie pól wejściowych dla umiejętności.
KnowledgeAgentAzureOpenAIModel	Określa zasób usługi Azure OpenAI używany do planowania zapytań.
KnowledgeAgentModelKind	Model sztucznej inteligencji, który ma być używany do planowania zapytań.
KnowledgeSourceKind	Rodzaj źródła wiedzy.
OutputFieldMappingEntry	Mapowanie pola wyjściowego dla umiejętności.
SearchIndexerDataNoneIdentity	Czyści właściwość tożsamości źródła danych.
SearchIndexerDataUserAssignedIdentity	Określa tożsamość źródła danych, które ma być używane.
SearchIndexKnowledgeSource	Źródło wiedzy przeznaczone dla indeksu wyszukiwania.
SearchIndexKnowledgeSourceParameters	Parametry źródła wiedzy indeksu wyszukiwania.
SearchResourceEncryptionKey	Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.
VectorSearchVectorizerKind	Metoda wektoryzacji, która ma być używana w czasie wykonywania zapytania.
WebApiParameters	Określa właściwości nawiązywania połączenia z wektoryzatorem zdefiniowanym przez użytkownika.
WebApiVectorizer	Określa wektoryzator zdefiniowany przez użytkownika do generowania osadzania wektora ciągu zapytania. Integracja zewnętrznego wektoryzatora jest osiągana przy użyciu niestandardowego interfejsu internetowego interfejsu API zestawu umiejętności.

AIFoundryModelCatalogName

Wyliczenie

Nazwa modelu osadzania z wykazu usługi Azure AI Foundry, który zostanie wywołany.

Wartość	Opis
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	Model Cohere embed v4 do generowania osadzania zarówno z tekstu, jak i obrazów.

AIServicesVisionParameters

Objekt

Określa parametry AI Services Vision do wektoryzacji obrazu lub tekstu zapytania.

Nazwa	Typ	Opis
apiKey	string	Klucz interfejsu API wyznaczonego zasobu usług AI.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Tożsamość zarządzana przypisana przez użytkownika używana dla połączeń wychodzących. Jeśli zostanie podany identyfikator authResourceId i nie zostanie on określony, zostanie użyta tożsamość zarządzana przypisana przez system. W przypadku aktualizacji indeksu, jeśli tożsamość jest nieokreślona, wartość pozostaje niezmieniona. Jeśli jest ustawiona na "none", wartość tej właściwości jest czyszczona.
modelVersion	string	Wersja modelu, która ma być używana podczas wywoływania usługi AI Services Vision. Domyślnie będzie to najnowsza dostępna, jeśli nie zostanie określona.
resourceUri	string (uri)	Identyfikator URI zasobu usług AI.

AIServicesVisionVectorizer

Objekt

Określa parametry AI Services Vision do wektoryzacji obrazu lub tekstu zapytania.

Nazwa	Typ	Opis
aiServicesVisionParameters	AIServicesVisionParameters	Zawiera parametry specyficzne dla wektoryzacji osadzania systemu wizyjnego AI Services.
kind	string: aiServicesVision	Nazwa rodzaju metody wektoryzacji konfigurowanej do użycia z wyszukiwaniem wektorowym.
name	string	Nazwa, którą należy skojarzyć z tą konkretną metodą wektoryzacji.

AMLParameters

Objekt

Określa właściwości nawiązywania połączenia z wektoryzatorem AML.

Nazwa	Typ	Opis
key	string	(Wymagane do uwierzytelniania za pomocą klucza) Klucz do usługi AML.
modelName	AIFoundryModelCatalogName	Nazwa modelu osadzania z wykazu usługi Azure AI Foundry, który jest wdrażany w podanym punkcie końcowym.
region	string	(Opcjonalnie w przypadku uwierzytelniania tokenu). Region, w którym jest wdrażana usługa AML.
resourceId	string	(Wymagane do uwierzytelniania tokenem). Identyfikator zasobu usługi Azure Resource Manager usługi AML. Powinien być w formacie subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.
timeout	string (duration)	(Opcjonalnie) Po określeniu wskazuje limit czasu dla klienta http wykonującego wywołanie interfejsu API.
uri	string (uri)	(Wymagane w przypadku braku uwierzytelniania lub uwierzytelniania za pomocą klucza) Identyfikator URI oceniania usługi AML, do której zostanie wysłany ładunek JSON. Dozwolony jest tylko schemat identyfikatora URI protokołu https.

AMLVectorizer

Objekt

Określa punkt końcowy usługi Azure Machine Learning wdrożony za pośrednictwem wykazu modeli usługi Azure AI Foundry w celu wygenerowania osadzania wektora ciągu zapytania.

Nazwa	Typ	Opis
amlParameters	AMLParameters	Określa właściwości wektoryzatora AML.
kind	string: aml	Nazwa rodzaju metody wektoryzacji konfigurowanej do użycia z wyszukiwaniem wektorowym.
name	string	Nazwa, którą należy skojarzyć z tą konkretną metodą wektoryzacji.

AzureActiveDirectoryApplicationCredentials

Objekt

Poświadczenia zarejestrowanej aplikacji utworzonej dla usługi wyszukiwania, używanej do uwierzytelnionego dostępu do kluczy szyfrowania przechowywanych w usłudze Azure Key Vault.

Nazwa	Typ	Opis
applicationId	string	Identyfikator aplikacji usługi AAD, któremu udzielono wymaganych uprawnień dostępu do usługi Azure Key Vault, który ma być używany podczas szyfrowania danych magazynowanych. Identyfikatora aplikacji nie należy mylić z identyfikatorem obiektu aplikacji usługi AAD.
applicationSecret	string	Klucz uwierzytelniania określonej aplikacji usługi AAD.

AzureBlobKnowledgeSource

Objekt

Konfiguracja źródła wiedzy Azure Blob Storage.

Nazwa	Typ	Opis
@odata.etag	string	Element ETag agenta.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	Typ źródła wiedzy.
description	string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey	SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz jest używany w celu zapewnienia dodatkowego poziomu szyfrowania magazynowanych dla definicji agenta, gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może ich odszyfrować. Po zaszyfrowaniu definicji agenta zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość zgodnie z potrzebami, jeśli chcesz obrócić klucz szyfrowania; Nie będzie to miało wpływu na definicję agenta. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne w przypadku bezpłatnych usług wyszukiwania i jest dostępne tylko w przypadku płatnych usług utworzonych 1 stycznia 2019 r. lub później.
kind	string: azureBlob	Typ źródła wiedzy.
name	string	Nazwa źródła wiedzy.

AzureBlobKnowledgeSourceParameters

Objekt

Parametry źródła wiedzy Azure Blob Storage.

Nazwa	Typ	Opis
chatCompletionModel	KnowledgeAgentModel: KnowledgeAgentAzureOpenAIModel	Opcjonalny model uzupełniania czatu do werbalizacji obrazu lub wyodrębniania kontekstu.
connectionString	string	Parametry połączenia oparte na kluczach lub format ResourceId w przypadku korzystania z tożsamości zarządzanej.
containerName	string	Nazwa kontenera usługi Blob Storage.
createdResources	object	Zasoby utworzone przez źródło wiedzy.
disableImageVerbalization	boolean	Wskazuje, czy werbalizacja obrazu powinna być wyłączona.
embeddingModel	VectorSearchVectorizer: AIServicesVisionVectorizer AMLVectorizer AzureOpenAIVectorizer WebApiVectorizer	Opcjonalna konfiguracja wektoryzatora do wektoryzacji zawartości.
folderPath	string	Opcjonalna ścieżka folderu w kontenerze.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Jawna tożsamość do użycia dla tego źródła wiedzy.
ingestionSchedule	IndexingSchedule	Opcjonalny harmonogram pozyskiwania danych.

AzureOpenAIEmbeddingSkill

Objekt

Umożliwia wygenerowanie osadzania wektora dla danego tekstu wejściowego przy użyciu zasobu usługi Azure OpenAI.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	Fragment identyfikatora URI określający typ umiejętności.
apiKey	string	Klucz interfejsu API wyznaczonego zasobu usługi Azure OpenAI.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Tożsamość zarządzana przypisana przez użytkownika używana dla połączeń wychodzących.
context	string	Reprezentuje poziom, na którym są wykonywane operacje, na przykład katalog główny dokumentu lub zawartość dokumentu (na przykład /document lub /document/content). Wartość domyślna to /document.
deploymentId	string	Identyfikator wdrożenia modelu usługi Azure OpenAI w wyznaczonym zasobie.
description	string	Opis umiejętności, który opisuje dane wejściowe, wyjściowe i użycie umiejętności.
dimensions	integer (int32)	Liczba wymiarów, które powinny mieć wynikowe osadzanie danych wyjściowych. Obsługiwane tylko w modelach text-embedding-3 i nowszych.
inputs	InputFieldMappingEntry[]	Dane wejściowe umiejętności mogą być kolumną w źródłowym zestawie danych lub danymi wyjściowymi umiejętności nadrzędnej.
modelName	AzureOpenAIModelName	Nazwa modelu osadzania, który jest wdrażany w podanej ścieżce deploymentId.
name	string	Nazwa umiejętności, która jednoznacznie identyfikuje ją w zestawie umiejętności. Umiejętność, która nie ma zdefiniowanej nazwy, otrzyma domyślną nazwę indeksu opartego na liczbie 1 w tablicy umiejętności, poprzedzoną znakiem "#".
outputs	OutputFieldMappingEntry[]	Dane wyjściowe umiejętności są albo polem w indeksie wyszukiwania, albo wartością, która może być używana jako dane wejściowe przez inną umiejętność.
resourceUri	string (uri)	Identyfikator URI zasobu usługi Azure OpenAI.

AzureOpenAIModelName

Wyliczenie

Nazwa modelu Azure Open AI, który zostanie wywołany.

Wartość	Opis
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

Objekt

Określa parametry nawiązywania połączenia z zasobem usługi Azure OpenAI.

Nazwa	Typ	Opis
apiKey	string	Klucz interfejsu API wyznaczonego zasobu usługi Azure OpenAI.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Tożsamość zarządzana przypisana przez użytkownika używana dla połączeń wychodzących.
deploymentId	string	Identyfikator wdrożenia modelu usługi Azure OpenAI w wyznaczonym zasobie.
modelName	AzureOpenAIModelName	Nazwa modelu osadzania, który jest wdrażany w podanej ścieżce deploymentId.
resourceUri	string (uri)	Identyfikator URI zasobu usługi Azure OpenAI.

AzureOpenAIVectorizer

Objekt

Określa zasób usługi Azure OpenAI używany do wektoryzacji ciągu zapytania.

Nazwa	Typ	Opis
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Zawiera parametry specyficzne dla wektoryzacji osadzania usługi Azure OpenAI.
kind	string: azureOpenAI	Nazwa rodzaju metody wektoryzacji konfigurowanej do użycia z wyszukiwaniem wektorowym.
name	string	Nazwa, którą należy skojarzyć z tą konkretną metodą wektoryzacji.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

IndexingSchedule

Objekt

Reprezentuje harmonogram wykonywania indeksatora.

Nazwa	Typ	Opis
interval	string (duration)	Interwał czasu między wykonaniami indeksatora.
startTime	string (date-time)	Czas, w którym indeksator powinien zacząć działać.

InputFieldMappingEntry

Objekt

Mapowanie pól wejściowych dla umiejętności.

Nazwa	Typ	Opis
inputs	InputFieldMappingEntry[]	Rekurencyjne dane wejściowe używane podczas tworzenia typu złożonego.
name	string	Nazwa danych wejściowych.
source	string	Źródło danych wejściowych.
sourceContext	string	Kontekst źródłowy używany do wybierania rekurencyjnych danych wejściowych.

KnowledgeAgentAzureOpenAIModel

Objekt

Określa zasób usługi Azure OpenAI używany do planowania zapytań.

Nazwa	Typ	Opis
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Zawiera parametry specyficzne dla punktu końcowego modelu usługi Azure OpenAI.
kind	string: azureOpenAI	Typ modelu AI.

KnowledgeAgentModelKind

Wyliczenie

Model sztucznej inteligencji, który ma być używany do planowania zapytań.

Wartość	Opis
azureOpenAI	Używanie modeli sztucznej inteligencji usługi Azure Open do planowania zapytań.

KnowledgeSourceKind

Wyliczenie

Rodzaj źródła wiedzy.

Wartość	Opis
searchIndex	Źródło wiedzy, które odczytuje dane z indeksu wyszukiwania.
azureBlob	Źródło wiedzy, które odczytuje i pozyskuje dane z Azure Blob Storage do indeksu wyszukiwania.

OutputFieldMappingEntry

Objekt

Mapowanie pola wyjściowego dla umiejętności.

Nazwa	Typ	Opis
name	string	Nazwa danych wyjściowych zdefiniowanych przez umiejętność.
targetName	string	Docelowa nazwa danych wyjściowych. Jest to opcjonalne i domyślnie ma nazwę użytkownika.

SearchIndexerDataNoneIdentity

Objekt

Czyści właściwość tożsamości źródła danych.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment identyfikatora URI określający typ tożsamości.

SearchIndexerDataUserAssignedIdentity

Objekt

Określa tożsamość źródła danych, które ma być używane.

Nazwa	Typ	Opis
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment identyfikatora URI określający typ tożsamości.
userAssignedIdentity	string	W pełni kwalifikowany identyfikator zasobu platformy Azure tożsamości zarządzanej przypisanej przez użytkownika zwykle w postaci "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", który powinien zostać przypisany do usługi wyszukiwania.

SearchIndexKnowledgeSource

Objekt

Źródło wiedzy przeznaczone dla indeksu wyszukiwania.

Nazwa	Typ	Opis
@odata.etag	string	Element ETag agenta.
description	string	Opcjonalny opis zdefiniowany przez użytkownika.
encryptionKey	SearchResourceEncryptionKey	Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz jest używany w celu zapewnienia dodatkowego poziomu szyfrowania magazynowanych dla definicji agenta, gdy chcesz mieć pełną pewność, że nikt, nawet firma Microsoft, nie może ich odszyfrować. Po zaszyfrowaniu definicji agenta zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość zgodnie z potrzebami, jeśli chcesz obrócić klucz szyfrowania; Nie będzie to miało wpływu na definicję agenta. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne w przypadku bezpłatnych usług wyszukiwania i jest dostępne tylko w przypadku płatnych usług utworzonych 1 stycznia 2019 r. lub później.
kind	string: searchIndex	Typ źródła wiedzy.
name	string	Nazwa źródła wiedzy.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Parametry źródła wiedzy.

SearchIndexKnowledgeSourceParameters

Objekt

Parametry źródła wiedzy indeksu wyszukiwania.

Nazwa	Typ	Opis
searchIndexName	string	Nazwa indeksu wyszukiwania.
sourceDataSelect	string	Służy do żądania dodatkowych pól dla danych źródłowych, do których się odwołuje.

SearchResourceEncryptionKey

Objekt

Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.

Nazwa	Typ	Opis
accessCredentials	AzureActiveDirectoryApplicationCredentials	Opcjonalne poświadczenia usługi Azure Active Directory używane do uzyskiwania dostępu do usługi Azure Key Vault. Nie jest to wymagane, jeśli zamiast tego używasz tożsamości zarządzanej.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Jawna tożsamość zarządzana do użycia dla tego klucza szyfrowania. Jeśli nie zostanie określona, a właściwość poświadczeń dostępu ma wartość null, zostanie użyta tożsamość zarządzana przypisana przez system. Podczas aktualizacji zasobu, jeśli jawna tożsamość nie jest określona, pozostaje niezmieniona. Jeśli określono wartość "none", wartość tej właściwości jest czyszczona.
keyVaultKeyName	string	Nazwa klucza usługi Azure Key Vault, który ma być używany do szyfrowania danych magazynowanych.
keyVaultKeyVersion	string	Wersja klucza usługi Azure Key Vault, która ma być używana do szyfrowania danych magazynowanych.
keyVaultUri	string	Identyfikator URI usługi Azure Key Vault, nazywany również nazwą DNS, który zawiera klucz, który ma być używany do szyfrowania danych magazynowanych. Przykładowym identyfikatorem URI może być `https://my-keyvault-name.vault.azure.net`.

VectorSearchVectorizerKind

Wyliczenie

Metoda wektoryzacji, która ma być używana w czasie wykonywania zapytania.

Wartość	Opis
azureOpenAI	Generowanie osadzania przy użyciu zasobu usługi Azure OpenAI w czasie wykonywania zapytania.
customWebApi	Generuj osadzanie przy użyciu niestandardowego internetowego punktu końcowego w czasie wykonywania zapytania.
aiServicesVision	Generowanie osadzania dla obrazu lub tekstu wejściowego w czasie wykonywania zapytania przy użyciu interfejsu API wektoryzacji usługi Azure AI Services Vision.
aml	Generowanie osadzania przy użyciu punktu końcowego usługi Azure Machine Learning wdrożonego za pośrednictwem wykazu modeli usługi Azure AI Foundry w czasie wykonywania zapytania.

WebApiParameters

Objekt

Określa właściwości nawiązywania połączenia z wektoryzatorem zdefiniowanym przez użytkownika.

Nazwa	Typ	Opis
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Tożsamość zarządzana przypisana przez użytkownika używana dla połączeń wychodzących. Jeśli zostanie podany identyfikator authResourceId i nie zostanie on określony, zostanie użyta tożsamość zarządzana przypisana przez system. W przypadku aktualizacji indeksatora, jeśli tożsamość jest nieokreślona, wartość pozostaje niezmieniona. Jeśli jest ustawiona na "none", wartość tej właściwości jest czyszczona.
authResourceId	string	Dotyczy niestandardowych punktów końcowych, które łączą się z kodem zewnętrznym w funkcji platformy Azure lub innej aplikacji, która zapewnia przekształcenia. Ta wartość powinna być identyfikatorem aplikacji utworzonym dla funkcji lub aplikacji podczas jej zarejestrowania w usłudze Azure Active Directory. Po określeniu wektoryzacja łączy się z funkcją lub aplikacją przy użyciu identyfikatora zarządzanego (systemowego lub przypisanego przez użytkownika) usługi wyszukiwania i tokenu dostępu funkcji lub aplikacji, używając tej wartości jako identyfikatora zasobu do tworzenia zakresu tokenu dostępu.
httpHeaders	object	Nagłówki wymagane do wysłania żądania HTTP.
httpMethod	string	Metoda żądania HTTP.
timeout	string (duration)	Żądany limit czasu żądania. Wartość domyślna to 30 sekund.
uri	string (uri)	Identyfikator URI internetowego interfejsu API udostępniającego wektoryzator.

WebApiVectorizer

Objekt

Określa wektoryzator zdefiniowany przez użytkownika do generowania osadzania wektora ciągu zapytania. Integracja zewnętrznego wektoryzatora jest osiągana przy użyciu niestandardowego interfejsu internetowego interfejsu API zestawu umiejętności.

Nazwa	Typ	Opis
customWebApiParameters	WebApiParameters	Określa właściwości wektoryzatora zdefiniowanego przez użytkownika.
kind	string: customWebApi	Nazwa rodzaju metody wektoryzacji konfigurowanej do użycia z wyszukiwaniem wektorowym.
name	string	Nazwa, którą należy skojarzyć z tą konkretną metodą wektoryzacji.