Knowledge Sources - Create Or Update

Tjänst:: Search Service

API-version:: 2025-08-01-preview

Skapar en ny kunskapskälla eller uppdaterar en kunskapskälla om den redan finns.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Slutpunkts-URL:en för söktjänsten.
sourceName	path	True	string	Namnet på den kunskapskälla som ska skapas eller uppdateras.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	Spårnings-ID:t som skickades med begäran för att hjälpa till med felsökning.
If-Match		string	Definierar villkoret If-Match. Åtgärden utförs endast om ETag på servern matchar det här värdet.
If-None-Match		string	Definierar villkoret Om-None-Match. Åtgärden utförs endast om ETag på servern inte matchar det här värdet.
Prefer	True	string	För HTTP PUT-begäranden instruerar tjänsten att returnera den skapade/uppdaterade resursen när den lyckas.

Begärandetext

Brödtexten i begäran kan vara något av följande:

Name	Description
AzureBlobKnowledgeSource	Konfiguration för Azure Blob Storage kunskapskälla.
SearchIndexKnowledgeSource	Kunskapskälla som riktar sig till ett sökindex.

AzureBlobKnowledgeSource

Konfiguration för Azure Blob Storage kunskapskälla.

Name	Obligatorisk	Typ	Description
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	Typen av kunskapskälla.
kind	True	string: azureBlob	Typen av kunskapskälla.
name	True	string	Namnet på kunskapskällan.
@odata.etag		string	ETag för agenten.
description		string	Valfri användardefinierad beskrivning.
encryptionKey		SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure 密钥保管库. Den här nyckeln används för att ge ytterligare en nivå av kryptering i vila för din agentdefinition när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera dem. När du har krypterat agentdefinitionen förblir den alltid krypterad. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Din agentdefinition påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.

SearchIndexKnowledgeSource

Kunskapskälla som riktar sig till ett sökindex.

Name	Obligatorisk	Typ	Description
kind	True	string: searchIndex	Typen av kunskapskälla.
name	True	string	Namnet på kunskapskällan.
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	Parametrarna för kunskapskällan.
@odata.etag		string	ETag för agenten.
description		string	Valfri användardefinierad beskrivning.
encryptionKey		SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure 密钥保管库. Den här nyckeln används för att ge ytterligare en nivå av kryptering i vila för din agentdefinition när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera dem. När du har krypterat agentdefinitionen förblir den alltid krypterad. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Din agentdefinition påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.

Svar

Name	Typ	Description
200 OK	KnowledgeSource: SearchIndexKnowledgeSource AzureBlobKnowledgeSource
201 Created	KnowledgeSource: SearchIndexKnowledgeSource AzureBlobKnowledgeSource
Other Status Codes	ErrorResponse	Felsvar.

Exempel

SearchServiceCreateOrUpdateKnowledgeSource

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

SearchServiceCreateOrUpdateKnowledgeSource

Exempelbegäran

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?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>"
    }
  }
}

Exempelsvar

Statuskod:: 200

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

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

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

Exempelbegäran

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?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>"
    }
  }
}

Exempelsvar

Statuskod:: 200

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

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

Definitioner

Name	Description
AIFoundryModelCatalogName	Namnet på inbäddningsmodellen från Azure AI Foundry-katalogen som ska anropas.
AIServicesVisionParameters	Anger AI Services Vision-parametrarna för vektorisering av en frågebild eller text.
AIServicesVisionVectorizer	Anger AI Services Vision-parametrarna för vektorisering av en frågebild eller text.
AMLParameters	Anger egenskaperna för anslutning till en AML-vektoriserare.
AMLVectorizer	Anger en Azure Machine Learning-slutpunkt som distribueras via Azure AI Foundry Model Catalog för att generera vektorinbäddningen av en frågesträng.
AzureActiveDirectoryApplicationCredentials	Autentiseringsuppgifter för ett registrerat program som skapats för din söktjänst och som används för autentiserad åtkomst till krypteringsnycklarna som lagras i Azure Key Vault.
AzureBlobKnowledgeSource	Konfiguration för Azure Blob Storage kunskapskälla.
AzureBlobKnowledgeSourceParameters	Parametrar för Azure Blob Storage kunskapskälla.
AzureOpenAIEmbeddingSkill	Gör att du kan generera en vektorinbäddning för en viss textinmatning med hjälp av Azure OpenAI-resursen.
AzureOpenAIModelName	Namnet på Azure Open AI-modellen som ska anropas.
AzureOpenAIParameters	Anger parametrarna för att ansluta till Azure OpenAI-resursen.
AzureOpenAIVectorizer	Anger den Azure OpenAI-resurs som används för att vektorisera en frågesträng.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
IndexingSchedule	Representerar ett schema för indexerarens körning.
InputFieldMappingEntry	Mappning av inmatningsfält för en färdighet.
KnowledgeAgentAzureOpenAIModel	Anger den Azure OpenAI-resurs som används för att göra frågeplanering.
KnowledgeAgentModelKind	AI-modellen som ska användas för frågeplanering.
KnowledgeSourceKind	Typen av kunskapskälla.
OutputFieldMappingEntry	Mappning av utdatafält för en färdighet.
SearchIndexerDataNoneIdentity	Rensar identitetsegenskapen för en datakälla.
SearchIndexerDataUserAssignedIdentity	Anger identiteten för en datakälla som ska användas.
SearchIndexKnowledgeSource	Kunskapskälla som riktar sig till ett sökindex.
SearchIndexKnowledgeSourceParameters	Parametrar för kunskapskälla för sökindex.
SearchResourceEncryptionKey	En kundhanterad krypteringsnyckel i Azure 密钥保管库. Nycklar som du skapar och hanterar kan användas för att kryptera eller dekryptera vilande data, till exempel index och synonymmappningar.
VectorSearchVectorizerKind	Den vektoriseringsmetod som ska användas under frågetiden.
WebApiParameters	Anger egenskaperna för anslutning till en användardefinierad vektoriserare.
WebApiVectorizer	Anger en användardefinierad vektoriserare för att generera vektorinbäddningen av en frågesträng. Integrering av en extern vektoriserare uppnås med hjälp av det anpassade webb-API-gränssnittet för en kompetensuppsättning.

AIFoundryModelCatalogName

Uppräkning

Namnet på inbäddningsmodellen från Azure AI Foundry-katalogen som ska anropas.

Värde	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	Cohere embed v4-modell för att generera inbäddningar från både text och bilder.

AIServicesVisionParameters

Objekt

Anger AI Services Vision-parametrarna för vektorisering av en frågebild eller text.

Name	Typ	Description
apiKey	string	API-nyckel för den angivna resursen för AI-tjänster.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Den användartilldelade hanterade identiteten som används för utgående anslutningar. Om ett authResourceId anges och det inte anges används den system tilldelade hanterade identiteten. Vid uppdateringar av indexet, om identiteten är ospecificerad, förblir värdet oförändrat. Om värdet är "none" rensas värdet för den här egenskapen.
modelVersion	string	Den version av modellen som ska användas när du anropar AI Services Vision-tjänsten. Den kommer som standard att vara den senaste tillgängliga när den inte anges.
resourceUri	string (uri)	Resurs-URI:n för AI Services-resursen.

AIServicesVisionVectorizer

Objekt

Anger AI Services Vision-parametrarna för vektorisering av en frågebild eller text.

Name	Typ	Description
aiServicesVisionParameters	AIServicesVisionParameters	Innehåller de parametrar som är specifika för AI Services Vision inbäddningsvektorisering.
kind	string: aiServicesVision	Namnet på den typ av vektoriseringsmetod som konfigureras för användning med vektorsökning.
name	string	Namnet som ska associeras med just den här vektoriseringsmetoden.

AMLParameters

Objekt

Anger egenskaperna för anslutning till en AML-vektoriserare.

Name	Typ	Description
key	string	(Krävs för nyckelautentisering) Nyckeln för AML-tjänsten.
modelName	AIFoundryModelCatalogName	Namnet på inbäddningsmodellen från Azure AI Foundry-katalogen som distribueras vid den angivna slutpunkten.
region	string	(Valfritt för tokenautentisering). Den region som AML-tjänsten distribueras i.
resourceId	string	(Krävs för tokenautentisering). Azure Resource Manager resurs-ID för AML-tjänsten. Det ska vara i formatet subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.
timeout	string (duration)	(Valfritt) När det anges anger tidsgränsen för http-klienten som gör API-anropet.
uri	string (uri)	(Krävs för ingen autentisering eller nyckelautentisering) Bedömnings-URI:n för AML-tjänsten som JSON-nyttolasten ska skickas till. Endast https URI-schemat tillåts.

AMLVectorizer

Objekt

Anger en Azure Machine Learning-slutpunkt som distribueras via Azure AI Foundry Model Catalog för att generera vektorinbäddningen av en frågesträng.

Name	Typ	Description
amlParameters	AMLParameters	Anger egenskaperna för AML-vektoriserare.
kind	string: aml	Namnet på den typ av vektoriseringsmetod som konfigureras för användning med vektorsökning.
name	string	Namnet som ska associeras med just den här vektoriseringsmetoden.

AzureActiveDirectoryApplicationCredentials

Objekt

Autentiseringsuppgifter för ett registrerat program som skapats för din söktjänst och som används för autentiserad åtkomst till krypteringsnycklarna som lagras i Azure Key Vault.

Name	Typ	Description
applicationId	string	Ett AAD-program-ID som har beviljats de åtkomstbehörigheter som krävs för att Azure Key Vault ska användas när du krypterar dina vilande data. Program-ID:t ska inte förväxlas med objekt-ID:t för ditt AAD-program.
applicationSecret	string	Autentiseringsnyckeln för det angivna AAD-programmet.

AzureBlobKnowledgeSource

Objekt

Konfiguration för Azure Blob Storage kunskapskälla.

Name	Typ	Description
@odata.etag	string	ETag för agenten.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	Typen av kunskapskälla.
description	string	Valfri användardefinierad beskrivning.
encryptionKey	SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure 密钥保管库. Den här nyckeln används för att ge ytterligare en nivå av kryptering i vila för din agentdefinition när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera dem. När du har krypterat agentdefinitionen förblir den alltid krypterad. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Din agentdefinition påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.
kind	string: azureBlob	Typen av kunskapskälla.
name	string	Namnet på kunskapskällan.

AzureBlobKnowledgeSourceParameters

Objekt

Parametrar för Azure Blob Storage kunskapskälla.

Name	Typ	Description
chatCompletionModel	KnowledgeAgentModel: KnowledgeAgentAzureOpenAIModel	Valfri modell för chattkomplettering för bildverbalisering eller kontextextrahering.
connectionString	string	Nyckelbaserad συμβολοσειρά σύνδεσης eller ResourceId-formatet om du använder en
containerName	string	Namnet på bloblagringscontainern.
createdResources	object	Resurser som skapats av kunskapskällan.
disableImageVerbalization	boolean	Anger om verbalisering av bilder ska inaktiveras.
embeddingModel	VectorSearchVectorizer: AIServicesVisionVectorizer AMLVectorizer AzureOpenAIVectorizer WebApiVectorizer	Valfri vektoriseringskonfiguration för vektorisering av innehåll.
folderPath	string	Valfri mappsökväg i containern.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	En explicit identitet som ska användas för den här kunskapskällan.
ingestionSchedule	IndexingSchedule	Valfritt schema för datainmatning.

AzureOpenAIEmbeddingSkill

Objekt

Gör att du kan generera en vektorinbäddning för en viss textinmatning med hjälp av Azure OpenAI-resursen.

Name	Typ	Description
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	Ett URI-fragment som anger typen av färdighet.
apiKey	string	API-nyckel för den angivna Azure OpenAI-resursen.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Den användartilldelade hanterade identiteten som används för utgående anslutningar.
context	string	Representerar den nivå på vilken åtgärder utförs, till exempel dokumentets rot eller dokumentinnehåll (till exempel /document eller /document/content). Standardvärdet är /document.
deploymentId	string	ID för Azure OpenAI-modelldistributionen på den angivna resursen.
description	string	Beskrivningen av färdigheten som beskriver indata, utdata och användning av färdigheten.
dimensions	integer (int32)	Antalet dimensioner som resulterande inbäddningar av utdata ska ha. Stöds endast i text-embedding-3 och senare modeller.
inputs	InputFieldMappingEntry[]	Indata för färdigheterna kan vara en kolumn i källdatauppsättningen eller utdata från en överordnad färdighet.
modelName	AzureOpenAIModelName	Namnet på inbäddningsmodellen som distribueras på den angivna deploymentId-sökvägen.
name	string	Namnet på färdigheten som unikt identifierar den i kompetensuppsättningen. En färdighet utan definierat namn får ett standardnamn för dess 1-baserade index i kompetensmatrisen, med prefixet "#".
outputs	OutputFieldMappingEntry[]	Utdata från en färdighet är antingen ett fält i ett sökindex eller ett värde som kan användas som indata av en annan färdighet.
resourceUri	string (uri)	Resurs-URI:n för Azure OpenAI-resursen.

AzureOpenAIModelName

Uppräkning

Namnet på Azure Open AI-modellen som ska anropas.

Värde	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

Objekt

Anger parametrarna för att ansluta till Azure OpenAI-resursen.

Name	Typ	Description
apiKey	string	API-nyckel för den angivna Azure OpenAI-resursen.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Den användartilldelade hanterade identiteten som används för utgående anslutningar.
deploymentId	string	ID för Azure OpenAI-modelldistributionen på den angivna resursen.
modelName	AzureOpenAIModelName	Namnet på inbäddningsmodellen som distribueras på den angivna deploymentId-sökvägen.
resourceUri	string (uri)	Resurs-URI:n för Azure OpenAI-resursen.

AzureOpenAIVectorizer

Objekt

Anger den Azure OpenAI-resurs som används för att vektorisera en frågesträng.

Name	Typ	Description
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Innehåller de parametrar som är specifika för Azure OpenAI-inbäddningsvektorisering.
kind	string: azureOpenAI	Namnet på den typ av vektoriseringsmetod som konfigureras för användning med vektorsökning.
name	string	Namnet som ska associeras med just den här vektoriseringsmetoden.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

IndexingSchedule

Objekt

Representerar ett schema för indexerarens körning.

Name	Typ	Description
interval	string (duration)	Tidsintervallet mellan indexerarkörningar.
startTime	string (date-time)	Den tid då en indexerare ska börja köras.

InputFieldMappingEntry

Objekt

Mappning av inmatningsfält för en färdighet.

Name	Typ	Description
inputs	InputFieldMappingEntry[]	Rekursiva indata som används när du skapar en komplex typ.
name	string	Namnet på indata.
source	string	Källan till indata.
sourceContext	string	Källkontexten som används för att välja rekursiva indata.

KnowledgeAgentAzureOpenAIModel

Objekt

Anger den Azure OpenAI-resurs som används för att göra frågeplanering.

Name	Typ	Description
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Innehåller de parametrar som är specifika för Azure OpenAI-modellens slutpunkt.
kind	string: azureOpenAI	Typ av AI-modell.

KnowledgeAgentModelKind

Uppräkning

AI-modellen som ska användas för frågeplanering.

Värde	Description
azureOpenAI	Använd Azure Open AI-modeller för frågeplanering.

KnowledgeSourceKind

Uppräkning

Typen av kunskapskälla.

Värde	Description
searchIndex	En kunskapskälla som läser data från ett sökindex.
azureBlob	En kunskapskälla som läser och matar in data från Azure Blob Storage till ett sökindex.

OutputFieldMappingEntry

Objekt

Mappning av utdatafält för en färdighet.

Name	Typ	Description
name	string	Namnet på utdata som definieras av färdigheten.
targetName	string	Målnamnet för utdata. Det är valfritt och standardvärdet är namn.

SearchIndexerDataNoneIdentity

Objekt

Rensar identitetsegenskapen för en datakälla.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Ett URI-fragment som anger typen av identitet.

SearchIndexerDataUserAssignedIdentity

Objekt

Anger identiteten för en datakälla som ska användas.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Ett URI-fragment som anger typen av identitet.
userAssignedIdentity	string	Det fullständigt kvalificerade Azure-resurs-ID:t för en användartilldelad hanterad identitet, vanligtvis i formatet "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" som skulle ha tilldelats till söktjänsten.

SearchIndexKnowledgeSource

Objekt

Kunskapskälla som riktar sig till ett sökindex.

Name	Typ	Description
@odata.etag	string	ETag för agenten.
description	string	Valfri användardefinierad beskrivning.
encryptionKey	SearchResourceEncryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure 密钥保管库. Den här nyckeln används för att ge ytterligare en nivå av kryptering i vila för din agentdefinition när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera dem. När du har krypterat agentdefinitionen förblir den alltid krypterad. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Din agentdefinition påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.
kind	string: searchIndex	Typen av kunskapskälla.
name	string	Namnet på kunskapskällan.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Parametrarna för kunskapskällan.

SearchIndexKnowledgeSourceParameters

Objekt

Parametrar för kunskapskälla för sökindex.

Name	Typ	Description
searchIndexName	string	Namnet på sökindexet.
sourceDataSelect	string	Används för att begära ytterligare fält för refererade källdata.

SearchResourceEncryptionKey

Objekt

En kundhanterad krypteringsnyckel i Azure 密钥保管库. Nycklar som du skapar och hanterar kan användas för att kryptera eller dekryptera vilande data, till exempel index och synonymmappningar.

Name	Typ	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Valfria Azure Active Directory-autentiseringsuppgifter som används för att komma åt din Azure Key Vault. Krävs inte om du använder hanterad identitet i stället.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	En explicit hanterad identitet som ska användas för den här krypteringsnyckeln. Om inget anges och egenskapen för autentiseringsuppgifter för åtkomst är null används den system tilldelade hanterade identiteten. Vid uppdatering av resursen, om den explicita identiteten är ospecificerad, förblir den oförändrad. Om "ingen" anges rensas värdet för den här egenskapen.
keyVaultKeyName	string	Namnet på din Azure Key Vault-nyckel som ska användas för att kryptera dina vilande data.
keyVaultKeyVersion	string	Den version av din Azure Key Vault-nyckel som ska användas för att kryptera dina vilande data.
keyVaultUri	string	URI:n för din Azure Key Vault, även kallat DNS-namn, som innehåller nyckeln som ska användas för att kryptera dina vilande data. Ett exempel på en URI kan vara `https://my-keyvault-name.vault.azure.net`.

VectorSearchVectorizerKind

Uppräkning

Den vektoriseringsmetod som ska användas under frågetiden.

Värde	Description
azureOpenAI	Generera inbäddningar med hjälp av en Azure OpenAI-resurs vid frågetillfället.
customWebApi	Generera inbäddningar med hjälp av en anpassad webbslutpunkt vid frågetillfället.
aiServicesVision	Generera inbäddningar för en bild eller textinmatning vid frågetillfället med hjälp av Azure AI Services Vision Vectorize-API:et.
aml	Generera inbäddningar med hjälp av en Azure Machine Learning-slutpunkt som distribueras via Azure AI Foundry Model Catalog vid frågetillfället.

WebApiParameters

Objekt

Anger egenskaperna för anslutning till en användardefinierad vektoriserare.

Name	Typ	Description
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Den användartilldelade hanterade identiteten som används för utgående anslutningar. Om ett authResourceId anges och det inte anges används den system tilldelade hanterade identiteten. Vid uppdateringar av indexeraren, om identiteten är ospecificerad, förblir värdet oförändrat. Om värdet är "none" rensas värdet för den här egenskapen.
authResourceId	string	Gäller för anpassade slutpunkter som ansluter till extern kod i en Azure-funktion eller något annat program som tillhandahåller transformeringarna. Det här värdet ska vara det program-ID som skapades för funktionen eller appen när den registrerades med Azure Active Directory. När det anges ansluter vektoriseringen till funktionen eller appen med hjälp av ett hanterat ID (antingen system eller användartilldelat) för söktjänsten och åtkomsttoken för funktionen eller appen, med hjälp av det här värdet som resurs-ID för att skapa omfånget för åtkomsttoken.
httpHeaders	object	De huvuden som krävs för att göra HTTP-begäran.
httpMethod	string	Metoden för HTTP-begäran.
timeout	string (duration)	Önskad tidsgräns för begäran. Standardvärdet är 30 sekunder.
uri	string (uri)	URI:n för webb-API:et som tillhandahåller vektoriseraren.

WebApiVectorizer

Objekt

Anger en användardefinierad vektoriserare för att generera vektorinbäddningen av en frågesträng. Integrering av en extern vektoriserare uppnås med hjälp av det anpassade webb-API-gränssnittet för en kompetensuppsättning.

Name	Typ	Description
customWebApiParameters	WebApiParameters	Anger egenskaperna för den användardefinierade vektoriseraren.
kind	string: customWebApi	Namnet på den typ av vektoriseringsmetod som konfigureras för användning med vektorsökning.
name	string	Namnet som ska associeras med just den här vektoriseringsmetoden.