Knowledge Bases - Create

Erstellt eine neue Wissensdatenbank.

POST {endpoint}/knowledgebases?api-version=2026-11-01-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string (uri)

Die Endpunkt-URL des Suchdiensts.

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
x-ms-client-request-id

string (uuid)

Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Accept

Accept

Der Accept-Header.

Anforderungstext

Name Erforderlich Typ Beschreibung
knowledgeSources True

KnowledgeSourceReference[]

Wissensquellen, die von dieser Wissensdatenbank referenziert werden.

name True

string

Der Name der Wissensbasis.

@odata.etag

string

Das ETag der Wissensdatenbank.

answerInstructions

string

Anweisungen, die von der Wissensdatenbank bei der Erstellung von Antworten berücksichtigt werden.

corsOptions

CorsOptions

Optionen zur Steuerung des Cross-Origin Resource Sharing (CORS) für die Wissensbasis.

description

string

Die Beschreibung der Wissensdatenbank.

encryptionKey

SearchResourceEncryptionKey

Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen.

models KnowledgeBaseModel[]:

Enthält Konfigurationsoptionen zum Herstellen einer Verbindung mit KI-Modellen.

outputMode

KnowledgeRetrievalOutputMode

Der Ausgabemodus für die Wissensdatenbank.

retrievalInstructions

string

Anweisungen, die von der Wissensdatenbank bei der Erstellung eines Abfrageplans berücksichtigt werden.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Die Konfiguration des Wiederholungs-Denkens.

retrieveDefaults

KnowledgeBaseRetrieveDefaults

Persistierte, request-weite Abruf-Standardwerte für diese Wissensdatenbank. Diese Werte gelten, um Anfragen abzurufen, die die entsprechenden Felder weglassen; Anfragezeitwerte haben Vorrang, wenn sie vorhanden sind.

tags

object

Benutzerdefinierte Schlüssel-Wert-Paare zur Kategorisierung der Wissensdatenbank sowie zur Verteilung ihrer Nutzung und Kosten.

tools

KnowledgeBaseTool[]

Benannte Abrufwerkzeuge, die jeweils auf eine Teilmenge der Quellen dieser Wissensdatenbank beschränkt sind. Wenn konfiguriert, wirbt MCP zusätzlich zum integrierten knowledge_base_retrieve-Tool für diese Werkzeuge, das aus der vollständigen Wissensdatenbank abruft. Das Auslassen von Tools oder das Bereitstellen eines leeren Arrays in dieser API-Version löscht bestehende Tools.

Antworten

Name Typ Beschreibung
201 Created

KnowledgeBase

Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt.

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name Beschreibung
https://search.azure.com/.default

Beispiele

SearchServiceCreateKnowledgeBase
SearchServiceCreateKnowledgeBaseMicrosoftRetriever1
SearchServiceCreateKnowledgeBaseOpenAICompatible
SearchServiceCreateKnowledgeBaseOpenAICompatibleSystemAssignedIdentity

SearchServiceCreateKnowledgeBase

Beispielanforderung

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases?api-version=2026-11-01-preview



{
  "name": "base-preview-test",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "tools": [
    {
      "name": "product-search",
      "description": "Search product documentation.",
      "knowledgeSources": [
        {
          "name": "ks-preview-test",
          "alwaysQuerySource": false,
          "filterAddOn": "id ne null",
          "maxOutputDocuments": 50,
          "failOnError": true
        }
      ],
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "retrieveDefaults": {
        "maxRuntimeInSeconds": 30,
        "maxOutputDocuments": 2,
        "maxOutputSizeInTokens": 5000
      }
    }
  ],
  "models": [
    {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "myDeployment",
        "apiKey": "api-key",
        "modelName": "gpt-4.1-nano"
      }
    }
  ],
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "outputMode": "extractiveData",
  "@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>"
    }
  },
  "description": "Description of the knowledge base.",
  "tags": {
    "businessUnit": "Contoso Engineering Department",
    "costCenter": "ABC-123",
    "owner": "Contoso"
  },
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis.",
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  },
  "retrieveDefaults": {
    "maxRuntimeInSeconds": 45,
    "maxOutputDocuments": 8,
    "maxOutputSizeInTokens": 12000
  }
}

Beispiel für eine Antwort

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "base-preview-test",
  "description": "Description of the knowledge base.",
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis.",
  "outputMode": "extractiveData",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "models": [
    {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "myDeployment",
        "apiKey": "api-key",
        "modelName": "gpt-4.1-nano"
      }
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "tags": {
    "businessUnit": "Contoso Engineering Department",
    "costCenter": "ABC-123",
    "owner": "Contoso"
  },
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  },
  "retrieveDefaults": {
    "maxRuntimeInSeconds": 45,
    "maxOutputDocuments": 8,
    "maxOutputSizeInTokens": 12000
  },
  "tools": [
    {
      "name": "product-search",
      "description": "Search product documentation.",
      "knowledgeSources": [
        {
          "name": "ks-preview-test",
          "alwaysQuerySource": false,
          "filterAddOn": "id ne null",
          "maxOutputDocuments": 50,
          "failOnError": true
        }
      ],
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "retrieveDefaults": {
        "maxRuntimeInSeconds": 30,
        "maxOutputDocuments": 2,
        "maxOutputSizeInTokens": 5000
      }
    }
  ]
}

SearchServiceCreateKnowledgeBaseMicrosoftRetriever1

Beispielanforderung

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases?api-version=2026-11-01-preview



{
  "name": "travel-knowledgebase",
  "knowledgeSources": [
    {
      "name": "hotels"
    }
  ],
  "models": [
    {
      "kind": "microsoftRetriever1"
    }
  ],
  "outputMode": "extractiveData",
  "description": "Find hotels using Microsoft Retriever 1."
}

Beispiel für eine Antwort

{
  "name": "travel-knowledgebase",
  "knowledgeSources": [
    {
      "name": "hotels"
    }
  ],
  "models": [
    {
      "kind": "microsoftRetriever1"
    }
  ],
  "outputMode": "extractiveData",
  "description": "Find hotels using Microsoft Retriever 1."
}

SearchServiceCreateKnowledgeBaseOpenAICompatible

Beispielanforderung

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases?api-version=2026-11-01-preview



{
  "name": "compatible-model-preview-test",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "tools": [
    {
      "name": "product-search",
      "description": "Search product documentation.",
      "knowledgeSources": [
        {
          "name": "ks-preview-test",
          "alwaysQuerySource": false,
          "filterAddOn": "id ne null",
          "maxOutputDocuments": 50,
          "failOnError": true
        }
      ],
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "retrieveDefaults": {
        "maxRuntimeInSeconds": 30,
        "maxOutputDocuments": 2,
        "maxOutputSizeInTokens": 5000
      }
    }
  ],
  "models": [
    {
      "kind": "openAICompatible",
      "openAICompatibleParameters": {
        "uri": "https://model-gateway.contoso.com/teams/catalog/chat/completions?route=primary&api-version=2026-01-01",
        "modelName": "gpt-4.1-mini",
        "headers": {
          "api-key": "EXAMPLE-NOT-A-REAL-SECRET"
        }
      }
    }
  ],
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "outputMode": "extractiveData",
  "@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>"
    }
  },
  "description": "Description of the knowledge base.",
  "tags": {
    "businessUnit": "Contoso Engineering Department",
    "costCenter": "ABC-123",
    "owner": "Contoso"
  },
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis.",
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  },
  "retrieveDefaults": {
    "maxRuntimeInSeconds": 45,
    "maxOutputDocuments": 8,
    "maxOutputSizeInTokens": 12000
  }
}

Beispiel für eine Antwort

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "compatible-model-preview-test",
  "description": "Description of the knowledge base.",
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis.",
  "outputMode": "extractiveData",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "models": [
    {
      "kind": "openAICompatible",
      "openAICompatibleParameters": {
        "uri": "https://model-gateway.contoso.com/teams/catalog/chat/completions?route=primary&api-version=2026-01-01",
        "modelName": "gpt-4.1-mini"
      }
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "tags": {
    "businessUnit": "Contoso Engineering Department",
    "costCenter": "ABC-123",
    "owner": "Contoso"
  },
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  },
  "retrieveDefaults": {
    "maxRuntimeInSeconds": 45,
    "maxOutputDocuments": 8,
    "maxOutputSizeInTokens": 12000
  },
  "tools": [
    {
      "name": "product-search",
      "description": "Search product documentation.",
      "knowledgeSources": [
        {
          "name": "ks-preview-test",
          "alwaysQuerySource": false,
          "filterAddOn": "id ne null",
          "maxOutputDocuments": 50,
          "failOnError": true
        }
      ],
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "retrieveDefaults": {
        "maxRuntimeInSeconds": 30,
        "maxOutputDocuments": 2,
        "maxOutputSizeInTokens": 5000
      }
    }
  ]
}

SearchServiceCreateKnowledgeBaseOpenAICompatibleSystemAssignedIdentity

Beispielanforderung

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases?api-version=2026-11-01-preview



{
  "name": "compatible-model-preview-test",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "tools": [
    {
      "name": "product-search",
      "description": "Search product documentation.",
      "knowledgeSources": [
        {
          "name": "ks-preview-test",
          "alwaysQuerySource": false,
          "filterAddOn": "id ne null",
          "maxOutputDocuments": 50,
          "failOnError": true
        }
      ],
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "retrieveDefaults": {
        "maxRuntimeInSeconds": 30,
        "maxOutputDocuments": 2,
        "maxOutputSizeInTokens": 5000
      }
    }
  ],
  "models": [
    {
      "kind": "openAICompatible",
      "openAICompatibleParameters": {
        "uri": "https://model-gateway.contoso.com/teams/catalog/chat/completions?route=primary&api-version=2026-01-01",
        "modelName": "gpt-4.1-mini",
        "managedIdentityAudience": "11111111-2222-3333-4444-555555555555"
      }
    }
  ],
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "outputMode": "extractiveData",
  "@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>"
    }
  },
  "description": "Description of the knowledge base.",
  "tags": {
    "businessUnit": "Contoso Engineering Department",
    "costCenter": "ABC-123",
    "owner": "Contoso"
  },
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis.",
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  },
  "retrieveDefaults": {
    "maxRuntimeInSeconds": 45,
    "maxOutputDocuments": 8,
    "maxOutputSizeInTokens": 12000
  }
}

Beispiel für eine Antwort

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "compatible-model-preview-test",
  "description": "Description of the knowledge base.",
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis.",
  "outputMode": "extractiveData",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "models": [
    {
      "kind": "openAICompatible",
      "openAICompatibleParameters": {
        "uri": "https://model-gateway.contoso.com/teams/catalog/chat/completions?route=primary&api-version=2026-01-01",
        "modelName": "gpt-4.1-mini",
        "managedIdentityAudience": "11111111-2222-3333-4444-555555555555"
      }
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "tags": {
    "businessUnit": "Contoso Engineering Department",
    "costCenter": "ABC-123",
    "owner": "Contoso"
  },
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  },
  "retrieveDefaults": {
    "maxRuntimeInSeconds": 45,
    "maxOutputDocuments": 8,
    "maxOutputSizeInTokens": 12000
  },
  "tools": [
    {
      "name": "product-search",
      "description": "Search product documentation.",
      "knowledgeSources": [
        {
          "name": "ks-preview-test",
          "alwaysQuerySource": false,
          "filterAddOn": "id ne null",
          "maxOutputDocuments": 50,
          "failOnError": true
        }
      ],
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "retrieveDefaults": {
        "maxRuntimeInSeconds": 30,
        "maxOutputDocuments": 2,
        "maxOutputSizeInTokens": 5000
      }
    }
  ]
}

Definitionen

Name Beschreibung
Accept

Der Accept-Header.

AzureOpenAIModelName

Der Name des Azure Open AI-Modells, der aufgerufen wird.

AzureOpenAIVectorizerParameters

Gibt die Parameter für die Verbindung mit der Azure OpenAI-Ressource an.

CorsOptions

Definiert Optionen zum Steuern der cross-Origin Resource Sharing (CORS) für einen Index.

ErrorAdditionalInfo

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

KnowledgeBase

Stellt eine Definition einer Wissensbasis dar.

KnowledgeBaseAzureOpenAIModel

Gibt die Azure OpenAI-Ressource an, die für die Abfrageplanung verwendet wird.

KnowledgeBaseMicrosoftRetriever1Model

Gibt Microsoft Retriever 1 an, der für Abfrageplanung und -abruf verwendet wird.

KnowledgeBaseModelKind

Das KI-Modell, das für die Abfrageplanung verwendet werden soll.

KnowledgeBaseOpenAICompatibleModel

Gibt ein kundengesteuertes, OpenAI-kompatibles Modell für den Wissensdatenbank-Abruf oder die Verbalisierung von Wissensquellbildern im Minimalmodus an. Zum Abrufen wählt das Modellprofil Chat-Abschlüsse oder Antworten aus. Nicht unterstützt für Standard-/CU-Extraktion oder Wissensdatenbanken mit Web-Wissensquellen.

KnowledgeBaseOpenAICompatibleParameters

Verbindungsparameter für einen OpenAI-kompatiblen Chat Completions oder Responses-Endpunkt. Die Erstellung erfordert genau einen der nichtleeren Header oder managedIdentityAudience. Updates können Header weglassen, um die Zugangsdaten für eine unveränderte Verbindung und ein Modellprofil zu erhalten.

KnowledgeBaseRetrieveDefaults

Bestehende anforderungsweite Standardeinstellungen für Anfragen zur Abruf der Wissensdatenbank. Jeder Wert liefert den Standard für das entsprechende Abruf-Anfragefeld; Service-Standardwerte gelten, wenn sie nicht gesetzt werden, und Anfragezeit-Werte haben Vorrang, wenn vorhanden.

KnowledgeBaseTool

Ein benanntes Abrufwerkzeug mit einer vom Kunden bereitgestellten Beschreibung und einem Teilsatz der Quellen seiner Wissensbasis.

KnowledgeBaseToolKnowledgeSourceReference

Eine Referenz auf eine bestehende Wissensquelle und eine ausgewählte Teilmenge der gespeicherten Abruf-Standardeinstellungen, nicht das vollständige Parametermodell zur Anfragezeit. Die referenzierte Quelle bestimmt den Typ; inkompatible Standardeinstellungen werden abgelehnt, wenn die Wissensdatenbank gespeichert wird. Explizite Abrufanfragewerte haben Vorrang, außer dass Filter mit AND kombiniert werden.

KnowledgeRetrievalAutoReasoningEffort

Wählen Sie automatisch den Schlussaufwand während des Abrufs aus. Der Service setzt jede Anfrage auf die günstigste Stufe und eskaliert nur so weit, wie nötig, bis zur maximal verfügbaren Stufe des Services.

KnowledgeRetrievalLowReasoningEffort

Führen Sie das Abrufen von Wissen mit geringem Argumentationsaufwand durch.

KnowledgeRetrievalMediumReasoningEffort

Führen Sie den Wissensabruf mit mittlerem Argumentationsaufwand durch.

KnowledgeRetrievalMinimalReasoningEffort

Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch.

KnowledgeRetrievalOutputMode

Die Ausgabekonfiguration für diesen Abruf.

KnowledgeRetrievalReasoningEffortKind

Der Aufwand, der beim Abrufen verwendet werden soll.

KnowledgeSourceReference

Verweise auf eine Wissensquelle.

SearchIndexerDataNoneIdentity

Löscht die Identitätseigenschaft einer Datenquelle.

SearchIndexerDataUserAssignedIdentity

Gibt die Identität für eine zu verwendende Datenquelle an.

SearchResourceEncryptionKey

Ein vom Kunden verwalteter Verschlüsselungsschlüssel im Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen.

Accept

Der Accept-Header.

Wert Beschreibung
application/json;odata.metadata=minimal

AzureOpenAIModelName

Der Name des Azure Open AI-Modells, der aufgerufen wird.

Wert Beschreibung
text-embedding-ada-002

TextEmbeddingAda002 Modell.

text-embedding-3-large

TextEmbedding3Großes Modell.

text-embedding-3-small

TextEmbedding3Kleines Modell.

gpt-4o

Gpt4o Modell.

gpt-4o-mini

Gpt4oMini-Modell.

gpt-4.1

Gpt41-Modell.

gpt-4.1-mini

Gpt41Mini Modell.

gpt-4.1-nano

Gpt41Nano-Modell.

gpt-5

Gpt5-Modell.

gpt-5-mini

Gpt5Mini-Modell.

gpt-5-nano

Gpt5Nano-Modell.

gpt-5.1

Gpt51 Modell.

gpt-5.2

Gpt52 Modell.

gpt-5.4

Gpt54-Modell.

gpt-5.4-mini

Gpt54Mini Modell.

gpt-5.4-nano

Gpt54Nano-Modell.

gpt-5.5

Gpt55-Modell.

gpt-5.6-sol

Gpt56Sol-Modell.

gpt-5.6-terra

Gpt56Terra Modell.

gpt-5.6-luna

Gpt56Luna Modell.

gpt-6-astra

Gpt6Astra-Modell.

gpt-6-sol

Gpt6Sol-Modell.

gpt-6-luna

Gpt6Luna Modell.

gpt-6.1-sol

Gpt61Sol-Modell.

AzureOpenAIVectorizerParameters

Gibt die Parameter für die Verbindung mit der Azure OpenAI-Ressource an.

Name Typ Beschreibung
apiKey

string

API-Schlüssel der angegebenen Azure OpenAI-Ressource.

authIdentity SearchIndexerDataIdentity:

Die vom Benutzer zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird.

deploymentId

string

ID der Azure OpenAI-Modellbereitstellung für die angegebene Ressource.

modelName

AzureOpenAIModelName

Der Name des Einbettungsmodells, das im bereitgestellten deploymentId-Pfad bereitgestellt wird.

resourceUri

string (uri)

Der Ressourcen-URI der Azure OpenAI-Ressource.

CorsOptions

Definiert Optionen zum Steuern der cross-Origin Resource Sharing (CORS) für einen Index.

Name Typ Beschreibung
allowedOrigins

string[]

Die Liste der Ursprünge, von denen aus JavaScript-Code Zugriff auf Ihren Index erhält. Kann eine Liste von Hosts in der Form {protocol}://{fully-qualified-domain-name}[:{port#}] oder ein einzelnes '*' enthalten, um alle Ursprünge zuzulassen (nicht empfohlen).

maxAgeInSeconds

integer (int64)

Die Dauer, für die Browser CORS-Preflight-Antworten zwischenspeichern sollen. Der Standardwert ist 5 Minuten.

ErrorAdditionalInfo

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

Name Typ Beschreibung
info

Zusätzliche Informationen.

type

string

Typ der Zusatzinformationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die Zusatzinformationen zum Fehler.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Der Fehlerzielwert.

ErrorResponse

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

KnowledgeBase

Stellt eine Definition einer Wissensbasis dar.

Name Typ Beschreibung
@odata.etag

string

Das ETag der Wissensdatenbank.

answerInstructions

string

Anweisungen, die von der Wissensdatenbank bei der Erstellung von Antworten berücksichtigt werden.

corsOptions

CorsOptions

Optionen zur Steuerung des Cross-Origin Resource Sharing (CORS) für die Wissensbasis.

description

string

Die Beschreibung der Wissensdatenbank.

encryptionKey

SearchResourceEncryptionKey

Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen.

knowledgeSources

KnowledgeSourceReference[]

Wissensquellen, die von dieser Wissensdatenbank referenziert werden.

models KnowledgeBaseModel[]:

Enthält Konfigurationsoptionen zum Herstellen einer Verbindung mit KI-Modellen.

name

string

Der Name der Wissensbasis.

outputMode

KnowledgeRetrievalOutputMode

Der Ausgabemodus für die Wissensdatenbank.

retrievalInstructions

string

Anweisungen, die von der Wissensdatenbank bei der Erstellung eines Abfrageplans berücksichtigt werden.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Die Konfiguration des Wiederholungs-Denkens.

retrieveDefaults

KnowledgeBaseRetrieveDefaults

Persistierte, request-weite Abruf-Standardwerte für diese Wissensdatenbank. Diese Werte gelten, um Anfragen abzurufen, die die entsprechenden Felder weglassen; Anfragezeitwerte haben Vorrang, wenn sie vorhanden sind.

tags

object

Benutzerdefinierte Schlüssel-Wert-Paare zur Kategorisierung der Wissensdatenbank sowie zur Verteilung ihrer Nutzung und Kosten.

tools

KnowledgeBaseTool[]

Benannte Abrufwerkzeuge, die jeweils auf eine Teilmenge der Quellen dieser Wissensdatenbank beschränkt sind. Wenn konfiguriert, wirbt MCP zusätzlich zum integrierten knowledge_base_retrieve-Tool für diese Werkzeuge, das aus der vollständigen Wissensdatenbank abruft. Das Auslassen von Tools oder das Bereitstellen eines leeren Arrays in dieser API-Version löscht bestehende Tools.

KnowledgeBaseAzureOpenAIModel

Gibt die Azure OpenAI-Ressource an, die für die Abfrageplanung verwendet wird.

Name Typ Beschreibung
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Azure OpenAI-Parameter.

kind string:

azureOpenAI

Das KI-Modell, das für die Abfrageplanung verwendet werden soll.

KnowledgeBaseMicrosoftRetriever1Model

Gibt Microsoft Retriever 1 an, der für Abfrageplanung und -abruf verwendet wird.

Name Typ Beschreibung
kind string:

microsoftRetriever1

Das KI-Modell, das für die Abfrageplanung verwendet werden soll.

KnowledgeBaseModelKind

Das KI-Modell, das für die Abfrageplanung verwendet werden soll.

Wert Beschreibung
azureOpenAI

Verwenden Sie Azure Open AI-Modelle für die Abfrageplanung.

openAICompatible

Verwenden Sie einen kundengesteuerten, OpenAI-kompatiblen Endpunkt für den Wissensdatenbank-Abruf oder die Verbalisierung von Wissensquellenbildern.

microsoftRetriever1

Verwenden Sie Microsoft Retriever 1 für Abfrageplanung und -abruf.

KnowledgeBaseOpenAICompatibleModel

Gibt ein kundengesteuertes, OpenAI-kompatibles Modell für den Wissensdatenbank-Abruf oder die Verbalisierung von Wissensquellbildern im Minimalmodus an. Zum Abrufen wählt das Modellprofil Chat-Abschlüsse oder Antworten aus. Nicht unterstützt für Standard-/CU-Extraktion oder Wissensdatenbanken mit Web-Wissensquellen.

Name Typ Beschreibung
kind string:

openAICompatible

Das KI-Modell, das für die Abfrageplanung verwendet werden soll.

openAICompatibleParameters

KnowledgeBaseOpenAICompatibleParameters

Verbindungs- und Authentifizierungsparameter für den OpenAI-kompatiblen Endpunkt.

KnowledgeBaseOpenAICompatibleParameters

Verbindungsparameter für einen OpenAI-kompatiblen Chat Completions oder Responses-Endpunkt. Die Erstellung erfordert genau einen der nichtleeren Header oder managedIdentityAudience. Updates können Header weglassen, um die Zugangsdaten für eine unveränderte Verbindung und ein Modellprofil zu erhalten.

Name Typ Beschreibung
authIdentity SearchIndexerDataIdentity:

Die vom Benutzer zugewiesene verwaltete Identität, die verwendet wurde, um ein Token für managedIdentityAudience zu erhalten. Lassen Sie die Verwendung der systemzugewiesenen Identität des Suchdienstes weg. Nur mit managedIdentityAudience erlaubt.

headers

object (password)

Nicht leere, gespeicherte HTTP-Header für die Endpunktauthentifizierung. Sowohl Namen als auch Werte sind geheim und werden nie als Antwort zurückgegeben. Leere Karten sind ungültig. Gegenseitig exklusiv mit managedIdentityAudience und authIdentity. Beim Update werden ausgelassene Header nur auf derselben Ressourcen- und Modellbindung beibehalten, wenn genau der Endpunkt, das Modellprofil und die Authentifizierungsidentität unverändert bleiben; ansonsten werden neue Zugangsdaten bereitgestellt.

managedIdentityAudience

string

Die pure kanonische Anwendung GUID der Drittanbieter-Anwendung Microsoft Entra des Kunden für verwaltete Identitätsauthentifizierung. Fügen Sie kein api://-Präfix oder die Suffix /.default ein. Gegenseitig ausgeschlossen mit Kopfzeilen.

modelName

AzureOpenAIModelName

Ein unterstützter Chat-Modellname, der die Fähigkeiten und Grenzen der Suche bestimmt. Für die Verbalisierung von Wissensquellbildern wird dies als Modellselektor im Anfragetext gesendet; der URI-Pfad wählt Chat-Abschlüsse oder Antworten unabhängig von diesem Namen aus. Für den Wissensdatenbank-Abruf verwenden GPT-6-Modellprofile Responses, während bestehende Modellprofile Chat-Completions verwenden; der Endpunkt muss das ausgewählte Protokoll unterstützen, einschließlich der fortsetzung des stateless Tools für Responses. Der Retrieval-Request-Body lässt das Modell weg; der URI oder das Gateway wählt das tatsächliche Modell aus und liefert jede erforderliche Provider-Modellidentifikatorin. Embedding-Modelle und beliebige Provider-Protokolle werden nicht unterstützt.

uri

string (uri)

Die vollständige HTTPS POST URL, einschließlich Pfad- und Abfrageparameter. Unverändert gesendet, ohne einen Pfad oder eine API-Version hinzuzufügen; Weiterleitungen werden nicht befolgt. Für den Wissensdatenbank-Abruf muss der Endpunkt das Chat-Completions- oder Responses-Protokoll des Modellprofils akzeptieren. Für die Verbalisierung von Wissensquellbildern muss der URI-Pfad mit /chat/completions oder /responses enden; Abfrageparameter wählen das Protokoll nicht aus.

KnowledgeBaseRetrieveDefaults

Bestehende anforderungsweite Standardeinstellungen für Anfragen zur Abruf der Wissensdatenbank. Jeder Wert liefert den Standard für das entsprechende Abruf-Anfragefeld; Service-Standardwerte gelten, wenn sie nicht gesetzt werden, und Anfragezeit-Werte haben Vorrang, wenn vorhanden.

Name Typ Beschreibung
maxOutputDocuments

integer (int32)

Die standardmäßige maximale Anzahl an Dokumenten im Abruf-Output.

maxOutputSizeInTokens

integer (int32)

Die Standardmaximalgröße, in Tokens, des Inhalts im Abruf-Output.

maxRuntimeInSeconds

integer (int32)

Die standardmäßige maximale Laufzeit in Sekunden für eine Abrufanforderung.

KnowledgeBaseTool

Ein benanntes Abrufwerkzeug mit einer vom Kunden bereitgestellten Beschreibung und einem Teilsatz der Quellen seiner Wissensbasis.

Name Typ Beschreibung
description

string

minLength: 1
maxLength: 1024

Eine nicht leere Beschreibung darüber, wann das Tool verwendet werden soll, höchstens 1024 Zeichen. Wortwörtlich im MCP-Katalog beworben.

knowledgeSources

KnowledgeBaseToolKnowledgeSourceReference[]

Eine nicht leere Liste eindeutiger Quellenangaben. Jede Quelle muss zur Wissensbasis gehören. Verschiedene Werkzeuge können auf dieselbe Quelle Bezug nehmen.

name

string

minLength: 2
maxLength: 64
pattern: ^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])$

Der einzigartige, groß-/klein-/kleinschreibungsabhängige Werkzeugname. Enthält 2 bis 64 Kleinbuchstaben ASCII-Buchstaben, Ziffern oder Bindestriche ohne führenden oder nachschließenden Bindestrich.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Es überlagert den Logikaufwand der Wissensdatenbank für dieses Tool. Explizite Abrufanfragenwerte haben Vorrang.

retrieveDefaults

KnowledgeBaseRetrieveDefaults

Rufen Sie Standardwerte ab, die die Standardwerte der Wissensdatenbank für dieses Tool überschreiben. Explizite Abrufanfragenwerte haben Vorrang.

KnowledgeBaseToolKnowledgeSourceReference

Eine Referenz auf eine bestehende Wissensquelle und eine ausgewählte Teilmenge der gespeicherten Abruf-Standardeinstellungen, nicht das vollständige Parametermodell zur Anfragezeit. Die referenzierte Quelle bestimmt den Typ; inkompatible Standardeinstellungen werden abgelehnt, wenn die Wissensdatenbank gespeichert wird. Explizite Abrufanfragewerte haben Vorrang, außer dass Filter mit AND kombiniert werden.

Name Typ Beschreibung
alwaysQuerySource

boolean

Ob die Quelle angefragt werden muss. Nicht für MCP-Serverquellen unterstützt. Eine explizite Anfrage-Ausnahme hat Vorrang.

failOnError

boolean

Ob der Abruf fehlschlagen sollte, wenn diese Quelle auf einen Fehler stößt.

filterAddOn

string

Ein zusätzlicher OData-Filter für Suchindexquellen. Abgelehnt für nicht unterstützte Quelltypen, wenn die Wissensdatenbank gespeichert wird. Kombiniert mit Quell- und Anfragefiltern unter Verwendung von AND.

maxOutputDocuments

integer (int32)

minimum: 50
maximum: 200

Die maximale Anzahl der aus dieser Quelle abgerufenen Dokumente liegt zwischen 50 und 200.

name

string

minLength: 1

Der Name einer Wissensquelle in der Wissensdatenbank.

rerankerThreshold

number (float)

Die Mindest-Reranker-Punktzahl für zurückgegebene Dokumente. Erfordert die Aktivierung des Neurankings.

KnowledgeRetrievalAutoReasoningEffort

Wählen Sie automatisch den Schlussaufwand während des Abrufs aus. Der Service setzt jede Anfrage auf die günstigste Stufe und eskaliert nur so weit, wie nötig, bis zur maximal verfügbaren Stufe des Services.

Name Typ Beschreibung
kind string:

auto

Die Art des Argumentationsaufwands.

KnowledgeRetrievalLowReasoningEffort

Führen Sie das Abrufen von Wissen mit geringem Argumentationsaufwand durch.

Name Typ Beschreibung
kind string:

low

Die Art des Argumentationsaufwands.

KnowledgeRetrievalMediumReasoningEffort

Führen Sie den Wissensabruf mit mittlerem Argumentationsaufwand durch.

Name Typ Beschreibung
kind string:

medium

Die Art des Argumentationsaufwands.

KnowledgeRetrievalMinimalReasoningEffort

Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch.

Name Typ Beschreibung
kind string:

minimal

Die Art des Argumentationsaufwands.

KnowledgeRetrievalOutputMode

Die Ausgabekonfiguration für diesen Abruf.

Wert Beschreibung
extractiveData

Geben Sie Daten aus den Wissensquellen direkt und ohne generative Änderung zurück.

answerSynthesis

Synthetisieren Sie eine Antwort für die Antwortnutzlast.

KnowledgeRetrievalReasoningEffortKind

Der Aufwand, der beim Abrufen verwendet werden soll.

Wert Beschreibung
minimal

Führt keine Quellenauswahl, Abfrageplanung oder iterative Suche durch.

low

Verwenden Sie beim Abrufen eine geringe Argumentation.

medium

Verwenden Sie beim Abrufen ein moderates Maß an Argumentation.

auto

Wähle automatisch den Argumentationsaufwand während des Abrufs aus und eskaliere nur so weit wie nötig von der günstigsten Stufe.

KnowledgeSourceReference

Verweise auf eine Wissensquelle.

Name Typ Beschreibung
enableFreshness

boolean

Gibt an, ob für diese Wissensquelle eine frischebewusste Abfrage aktiviert werden sollte. Wenn zutreffend, wird beim Abruf ein Frische-Bewertungsprofil angewendet, um Ergebnisse zugunsten neuerer Dokumente zu verzerren.

enableImageServing

boolean

Gibt an, ob die Bildbereitstellung für diese Wissensquelle aktiviert werden sollte. Wenn zutreffend, werden während der Aufnahme extrahierte Bilder zur Abfragezeit an nachgelagerte Modelle geliefert.

name

string

Der Name der Wissensquelle.

SearchIndexerDataNoneIdentity

Löscht die Identitätseigenschaft einer Datenquelle.

Name Typ Beschreibung
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Ein URI-Fragment, das den Typ der Identität angibt.

SearchIndexerDataUserAssignedIdentity

Gibt die Identität für eine zu verwendende Datenquelle an.

Name Typ Beschreibung
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Ein URI-Fragment, das den Typ der Identität angibt.

federatedIdentityClientId

string

Multi-Tenant User-Assigned Managed Identity Support: Die Client-ID der Multi-Tentant-App, die so konfiguriert wurde, dass sie mit der vom Benutzer zugewiesenen verwalteten Identität föderiert.

userAssignedIdentity

string

Die vollqualifizierte Azure-Ressourcen-ID einer vom Benutzer zugewiesenen verwalteten Identität in der Regel im Format "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", die dem Suchdienst zugewiesen werden sollen.

SearchResourceEncryptionKey

Ein vom Kunden verwalteter Verschlüsselungsschlüssel im Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen.

Name Typ Standardwert Beschreibung
accessCredentials.applicationId

string

Eine AAD-Anwendungs-ID, die die erforderlichen Zugriffsberechtigungen für den Azure Key Vault erteilt hat, die beim Verschlüsseln Ihrer ruhenden Daten verwendet werden sollen. Die Anwendungs-ID sollte nicht mit der Objekt-ID für Ihre AAD-Anwendung verwechselt werden.

accessCredentials.applicationSecret

string

Der Authentifizierungsschlüssel der angegebenen AAD-Anwendung.

identity SearchIndexerDataIdentity:

Eine explizite verwaltete Identität, die für diesen Verschlüsselungsschlüssel verwendet werden soll. Wenn diese Eigenschaft nicht angegeben ist und die Eigenschaft für Zugriffsanmeldeinformationen null ist, wird die vom System zugewiesene verwaltete Identität verwendet. Wenn die explizite Identität nicht angegeben ist, bleibt die Aktualisierung der Ressource unverändert. Wenn "none" angegeben wird, wird der Wert dieser Eigenschaft gelöscht.

isServiceLevelKey

boolean

False

Ein optionaler Wert, der angibt, ob dieser Schlüssel ein Service-Level-Schlüssel ist. Die Standardeinstellung ist "false".

keyVaultKeyName

string

Der Name Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll.

keyVaultKeyVersion

string

Die Version Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll.

keyVaultUri

string

Der URI Ihres Azure Key Vault, auch als DNS-Name bezeichnet, der den Schlüssel enthält, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll. Ein Beispiel-URI kann https://my-keyvault-name.vault.azure.netsein.