Erstellen einer Remote-SharePoint Wissensquelle (Vorschau)

Hinweis

Foundry IQ (Azure KI-Suche) bietet direkte Indizierungs- und Abfrage-APIs zusammen mit Wissensquellen- und Knowledge Base-APIs auf höherer Ebene für den verwalteten Abruf. Verwenden Sie das Azure Portal, REST-APIs oder Azure SDKs, um diese Funktionen zu konfigurieren, oder verbinden Sie Agents mit Wissensdatenbanken im Microsoft Foundry-Portal.

Important

Remote SharePoint-Wissensquelle befindet sich in der öffentlichen Vorschau und unterliegt den ergänzenden Nutzungsbedingungen für Microsoft Azure Previews.

Die für dieses Feature geltenden Vorschaubedingungen finden Sie unter Previewfunktionalität.

Ausdrücke, die beim Herstellen einer Verbindung mit externen Datenquellen gelten, finden Sie unter "Externe Datenquellen".

Eine Remote-SharePoint Wissensquelle (Vorschau) verwendet die Copilot Retrieval API (Vorschau), um SharePoint Text aus dem Microsoft 365 Hybridindex abzurufen. Wissensquellen werden unabhängig erstellt, in einer Wissensbasis referenziert und als Erdungsdaten verwendet, wenn die Wissensbasis zur Laufzeit abgefragt wird.

Wenn Sie Websites einschränken oder die Suche einschränken möchten, legen Sie einen Filterausdruck auf den Bereich nach URLs, Datumsbereichen, Dateitypen und anderen Metadaten fest. Die Identität des Aufrufers muss sowohl vom Azure Mandanten als auch vom Microsoft 365 Mandanten erkannt werden, da das Abrufmodul im Auftrag des Benutzers SharePoint abfragt.

Im Gegensatz zu indizierten Wissensquellen verwendet der Remote-SharePoint-Abruf das SharePoint-Berechtigungsmodell und Microsoft 365 Governance-Steuerelemente ohne einen separaten Suchindex oder geplante Synchronisierung von Inhalten und ACLs. Bei diesem Ansatz wird eine zusätzliche plattformübergreifende Synchronisierungsverzögerung vermieden. Aktualität hängt immer noch von der Verarbeitung durch Microsoft 365 ab. Sie benötigen keine Verbindungszeichenfolge zu verwenden.

Informationen zu Autorisierungs-, Aktualitäts- und betrieblichen Abwägungen finden Sie unter Vergleichen von Remote-, indizierten und vom Kunden verwalteten Pushabrufen.

Verwendungsunterstützung

Azure Portal Microsoft Foundry-Portal .NET SDK Python SDK Java SDK JavaScript SDK REST-API
✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️

Voraussetzungen

  • Das neueste Azure.Search.Documents Vorschaupaket: dotnet add package Azure.Search.Documents --prerelease

  • Für die schlüssellose Authentifizierung das Paket Azure.Identity: dotnet add package Azure.Identity

  • Das neueste azure-search-documents Vorschaupaket: pip install --pre azure-search-documents

  • Für die schlüssellose Authentifizierung das Paket azure-identity: pip install azure-identity

Einschränkungen und Überlegungen

Remote-SharePoint Wissensquellen unterliegen Einschränkungen der Copilot Retrieval API und Foundry IQ.

Copilot Abruf-API

Die folgenden Einschränkungen der Copilot Retrieval API gelten auch für Remote-SharePoint-Wissensquellen:

  • Es gibt keine Unterstützung für Copilot Connectors oder OneDrive Inhalte. Inhalte werden nur von SharePoint Websites abgerufen.

  • Grenzwert von 200 Anforderungen pro Benutzer pro Stunde.

  • Abfragezeichenbeschränkung von 1.500 Zeichen.

  • Hybridabfragen werden nur für die folgenden Dateierweiterungen unterstützt: .doc, , .docx, .pptx, , .pdfund .aspx.one.

  • Der multimodale Abruf (nichttextueller Inhalt, einschließlich Tabellen, Bildern und Diagrammen) wird nicht unterstützt.

  • Maximal 25 Ergebnisse aus einer Abfrage.

  • Ergebnisse werden von der Copilot Abruf-API als ungeordnet zurückgegeben.

  • Ungültige KQL-Filterausdrücke (Keyword Query Language) werden ignoriert, und die Abfrage wird ohne den Filter weiterhin ausgeführt.

Gießerei IQ

Wenn Sie eine Wissensbasis abfragen, kann Foundry IQ jeweils eine begrenzte Anzahl von Remote-SharePoint Abfragen ausführen. Der Grenzwert hängt vom Preismodell ab:

  • Dediziert: Jedes Dienstreplikat führt jeweils eine Abfrage über alle Remote-SharePoint Wissensquellen aus, die für die Abrufanforderung ausgewählt sind. Zusätzliche Abfragen warten auf ein verfügbares Replikat, wodurch die Latenz erhöht wird. Um den Abfragedurchsatz zu erhöhen, fügen Sie Replikate hinzu.

  • Serverlos: Foundry IQ führt jeweils eine Abfrage über alle Remote SharePoint-Wissensquellen aus, die für die Abrufanforderung ausgewählt sind. Weitere Abfragen warten. Serverless verwaltet die Kapazität automatisch, sodass Sie den Abfragedurchsatz nicht erhöhen können.

Überprüfen auf vorhandene Wissensquellen

Eine Wissensquelle ist ein wiederverwendbares Objekt auf oberster Ebene. Das Wissen über vorhandene Wissensquellen ist hilfreich, um neue Objekte wiederzuverwenden oder zu benennen.

Führen Sie den folgenden Code aus, um Wissensquellen nach Namen und Typ auflisten.

// List knowledge sources by name and type
using Azure.Search.Documents.Indexes;

var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);
var knowledgeSources = indexClient.GetKnowledgeSourcesAsync();

Console.WriteLine("Knowledge Sources:");

await foreach (var ks in knowledgeSources)
{
    Console.WriteLine($"  Name: {ks.Name}, Type: {ks.GetType().Name}");
}

Reference:SearchIndexClient

# List knowledge sources by name and type
from azure.core.credentials import AzureKeyCredential
from azure.search.documents.indexes import SearchIndexClient

index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))

for ks in index_client.list_knowledge_sources():
    print(f"  - {ks.name} ({ks.kind})")

Reference:SearchIndexClient

### List knowledge sources by name and type
GET {{search-url}}/knowledgesources?api-version={{api-version}}&$select=name,kind
Authorization: Bearer {{token}}

Referenz:Wissensquellen - Liste

Sie können auch eine einzelne Wissensquelle anhand des Namens zurückgeben, um die JSON-Definition zu überprüfen.

using Azure.Search.Documents.Indexes;
using System.Text.Json;

var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);

// Specify the knowledge source name to retrieve
string ksNameToGet = "earth-knowledge-source";

// Get its definition
var knowledgeSourceResponse = await indexClient.GetKnowledgeSourceAsync(ksNameToGet);
var ks = knowledgeSourceResponse.Value;

// Serialize to JSON for display
var jsonOptions = new JsonSerializerOptions 
{ 
    WriteIndented = true,
    DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.Never
};
Console.WriteLine(JsonSerializer.Serialize(ks, ks.GetType(), jsonOptions));

Reference:SearchIndexClient

# Get a knowledge source definition
from azure.core.credentials import AzureKeyCredential
from azure.search.documents.indexes import SearchIndexClient
import json

index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))

ks = index_client.get_knowledge_source("knowledge_source_name")
print(json.dumps(ks.as_dict(), indent = 2))

Reference:SearchIndexClient

### Get a knowledge source definition
GET {{search-url}}/knowledgesources('{{knowledge-source-name}}')?api-version={{api-version}}
Authorization: Bearer {{token}}

Referenz:Wissensquellen - Abrufen

Der folgende JSON-Code ist eine Beispielantwort für eine Remote-SharePoint Wissensquelle.

{
  "name": "my-sharepoint-ks",
  "kind": "remoteSharePoint",
  "description": "A sample remote SharePoint knowledge source",
  "encryptionKey": null,
  "remoteSharePointParameters": {
    "filterExpression": "filetype:docx",
    "containerTypeId": null,
    "resourceMetadata": [
      "Author",
      "Title"
    ]
  }
}

Erstellen einer Wissensquelle

Führen Sie den folgenden Code aus, um eine Remote-SharePoint Wissensquelle zu erstellen.

// Create a remote SharePoint knowledge source
using Azure.Search.Documents.Indexes;
using Azure.Search.Documents.Indexes.Models;
using Azure.Search.Documents.KnowledgeBases.Models;
using Azure.Identity;

var indexClient = new SearchIndexClient(new Uri(searchEndpoint), new DefaultAzureCredential());

var knowledgeSource = new RemoteSharePointKnowledgeSource(name: "my-remote-sharepoint-ks")
{
    Description = "This knowledge source queries .docx files in a trusted Microsoft 365 tenant.",
    RemoteSharePointParameters = new RemoteSharePointKnowledgeSourceParameters()
    {
        FilterExpression = "filetype:docx",
        ResourceMetadata = { "Author", "Title" }
    }
};

await indexClient.CreateOrUpdateKnowledgeSourceAsync(knowledgeSource);
Console.WriteLine($"Knowledge source '{knowledgeSource.Name}' created or updated successfully.");

Reference:SearchIndexClient, RemoteSharePointKnowledgeSource

# Create a remote SharePoint knowledge source
from azure.identity import DefaultAzureCredential
from azure.search.documents.indexes import SearchIndexClient
from azure.search.documents.indexes.models import RemoteSharePointKnowledgeSource, RemoteSharePointKnowledgeSourceParameters

index_client = SearchIndexClient(endpoint = "<search-endpoint>", credential = DefaultAzureCredential())

knowledge_source = RemoteSharePointKnowledgeSource(
    name = "my-remote-sharepoint-ks",
    description= "This knowledge source queries .docx files in a trusted Microsoft 365 tenant.",
    encryption_key = None,
    remote_share_point_parameters = RemoteSharePointKnowledgeSourceParameters(
        filter_expression = "filetype:docx",
        resource_metadata = ["Author", "Title"],
        container_type_id = None
    )
)

index_client.create_or_update_knowledge_source(knowledge_source)
print(f"Knowledge source '{knowledge_source.name}' created or updated successfully.")

Reference:SearchIndexClient

### Create a remote SharePoint knowledge source
PUT {{search-endpoint}}/knowledgesources/my-remote-sharepoint-ks?api-version=2026-11-01-preview
Authorization: Bearer {{search-access-token}}
Content-Type: application/json

{
    "name": "my-remote-sharepoint-ks",
    "kind": "remoteSharePoint",
    "description": "This knowledge source queries .docx files in a trusted Microsoft 365 tenant.",
    "encryptionKey": null,
    "remoteSharePointParameters": {
        "filterExpression": "filetype:docx",
        "resourceMetadata": [ "Author", "Title" ],
        "containerTypeId": null
    }
}

Referenz:Wissensquellen – Erstellen oder Aktualisieren

Beispiele für Filterausdrücke

Nicht alle SharePoint Eigenschaften werden im filterExpression unterstützt. Eine Liste der unterstützten Eigenschaften finden Sie in der API-Referenz. Informationen zu abfragbaren Eigenschaften finden Sie unter "Queryable".

Weitere Informationen zu KQL-Filtern finden Sie in der Syntaxreferenz.

Beispiel Filterausdruck
Nach einer einzelnen Website mittels ID filtern "filterExpression": "SiteID:\"00aa00aa-bb11-cc22-dd33-44ee44ee44ee\""
Nach ID auf mehrere Websites filtern "filterExpression": "SiteID:\"00aa00aa-bb11-cc22-dd33-44ee44ee44ee\" OR SiteID:\"11bb11bb-cc22-dd33-ee44-55ff55ff55ff\""
Filtern nach Dateien unter einem bestimmten Pfad "filterExpression": "Path:\"https://my-demo.sharepoint.com/sites/mysite/Shared Documents/en/mydocs\""
Filtern nach einem bestimmten Datumsbereich "filterExpression": "LastModifiedTime >= 2024-07-22 AND LastModifiedTime <= 2025-01-08"
Filtern nach Dateien eines bestimmten Dateityps "filterExpression": "FileExtension:\"docx\" OR FileExtension:\"pdf\" OR FileExtension:\"pptx\""
Filtern nach Dateien einer bestimmten Informationsschutzbezeichnung "filterExpression": "InformationProtectionLabelId:\"f0ddcc93-d3c0-4993-b5cc-76b0a283e252\""

Zuweisen zu einer Wissensbasis

Wenn Sie mit der Wissensquelle zufrieden sind, fügen Sie sie einer Wissensbasis hinzu.

Abfragen einer Wissensbasis

Nachdem die Wissensdatenbank konfiguriert wurde, rufen Sie die Abrufaktion oder den MCP-Endpunkt auf, um SharePoint-Inhalte abzufragen. Remote-SharePoint verfügt über quellspezifische Verhaltensweisen für abfragezeitfilterung, Abfrageformulierung, Antwortfelder und Erzwingung von Berechtigungen.

Wenden Sie einen KQL-Filter bei der Abfrage an.

Sie können eine FilterExpressionAddOn in der KnowledgeSourceParams zur Abrufanforderung übergeben, um zur Abfragezeit einen KQL-Filter anzuwenden. Wenn Sie FilterExpressionAddOn bei der Abrufanforderung und ein FilterExpression bei der Wissensquelldefinition angeben, werden die Filter mit UND verknüpft.

var retrievalRequest = new KnowledgeBaseRetrievalRequest();
retrievalRequest.Messages.Add(
    new KnowledgeBaseMessage(
        content: new[] {
            new KnowledgeBaseMessageTextContent("contoso product planning")
        }
    ) { Role = "user" }
);
retrievalRequest.KnowledgeSourceParams.Add(
    new RemoteSharePointKnowledgeSourceParams("my-remote-sharepoint-ks")
    {
        FilterExpressionAddOn = "filetype:docx"
    }
);

var result = await kbClient.RetrieveAsync(
    retrievalRequest, xMsQuerySourceAuthorization: token
);

Referenz:KnowledgeBaseRetrievalClient, KnowledgeBaseRetrievalRequest

Sie können eine filter_expression_add_on in der knowledge_source_params zur Abrufanforderung übergeben, um zur Abfragezeit einen KQL-Filter anzuwenden. Wenn Sie filter_expression_add_on bei der Abrufanforderung und ein filter_expression bei der Wissensquelldefinition angeben, werden die Filter mit UND verknüpft.

from azure.search.documents.knowledgebases.models import (
    KnowledgeBaseMessage,
    KnowledgeBaseMessageTextContent,
    KnowledgeBaseRetrievalRequest,
    RemoteSharePointKnowledgeSourceParams,
)

request = KnowledgeBaseRetrievalRequest(
    messages=[
        KnowledgeBaseMessage(
            role="user",
            content=[
                KnowledgeBaseMessageTextContent(
                    text="contoso product planning"
                )
            ],
        )
    ],
    knowledge_source_params=[
        RemoteSharePointKnowledgeSourceParams(
            knowledge_source_name="my-remote-sharepoint-ks",
            filter_expression_add_on="filetype:docx",
        )
    ],
)

result = kb_client.retrieve(
    retrieval_request=request,
    x_ms_query_source_authorization=token,
)

Referenz:KnowledgeBaseRetrievalClient, KnowledgeBaseRetrievalRequest

Sie können eine filterExpressionAddOn in der knowledgeSourceParams zur Abrufanforderung übergeben, um zur Abfragezeit einen KQL-Filter anzuwenden. Wenn Sie filterExpressionAddOn bei der Abrufanforderung und ein filterExpression bei der Wissensquelldefinition angeben, werden die Filter mit UND verknüpft.

### Retrieve knowledge base content
POST {{search-endpoint}}/knowledgebases/{{knowledge-base-name}}/retrieve?api-version=2026-11-01-preview
Authorization: Bearer {{search-access-token}}
Content-Type: application/json
x-ms-query-source-authorization: {{user-access-token}}

{
    "messages": [
        {
            "role": "user",
            "content": [
                { "type": "text", "text": "contoso product planning" }
            ]
        }
    ],
    "knowledgeSourceParams": [
        {
            "knowledgeSourceName": "my-remote-sharepoint-ks",
            "kind": "remoteSharePoint",
            "filterExpressionAddOn": "filetype:docx"
        }
    ]
}

Reference:Knowledge Retrieval - Abrufen

Schreiben effektiver Abfragen

Abfragen, die sich mit dem Inhalt selbst befassen, sind effektiver als Fragen über den Speicherort einer Datei oder wann sie zuletzt aktualisiert wurde. Zum Beispiel könnte "Wo ist das Keynote-Dokument für Ignite 2024?" keine Ergebnisse liefern, weil der Inhalt selbst seinen Standort nicht offenlegt. Ein FilterExpression bei Metadaten ist ein besserer Ansatz für Ablageort- oder datumsspezifische Abfragen.

Abfragen, die sich mit dem Inhalt selbst befassen, sind effektiver als Fragen über den Speicherort einer Datei oder wann sie zuletzt aktualisiert wurde. Zum Beispiel könnte "Wo ist das Keynote-Dokument für Ignite 2024?" keine Ergebnisse liefern, weil der Inhalt selbst seinen Standort nicht offenlegt. Ein filter_expression bei Metadaten ist ein besserer Ansatz für Ablageort- oder datumsspezifische Abfragen.

Abfragen, die sich mit dem Inhalt selbst befassen, sind effektiver als Fragen über den Speicherort einer Datei oder wann sie zuletzt aktualisiert wurde. Zum Beispiel könnte "Wo ist das Keynote-Dokument für Ignite 2024?" keine Ergebnisse liefern, weil der Inhalt selbst seinen Standort nicht offenlegt. Ein filterExpression bei Metadaten ist ein besserer Ansatz für Ablageort- oder datumsspezifische Abfragen.

Eine effektivere Frage ist "Was ist das Keynote-Dokument für Ignite 2024". Die Antwort enthält die synthetisierte Antwort, Abfrageaktivität und Tokenanzahl sowie die URL und andere Metadaten.

SharePoint-spezifische Antwortfelder

Remote-SharePoint Ergebnisse umfassen Felder, die nicht für andere Wissensquellentypen angezeigt werden, z. B. resourceMetadata, webUrl und searchSensitivityLabelInfo.

{
    "resourceMetadata": {
        "Author": "Nuwan Amarathunga;Nurul Izzati",
        "Title": "Ignite 2024 Keynote Address"
    },
    "rerankerScore": 2.489522,
    "webUrl": "https://contoso-my.sharepoint.com/keynotes/Documents/Keynote-Ignite-2024.docx",
    "searchSensitivityLabelInfo": {
        "displayName": "Confidential\\Contoso Extended",
        "sensitivityLabelId": "aaaaaaaa-0b0b-1c1c-2d2d-333333333333",
        "tooltip": "Data is classified and protected.",
        "priority": 5,
        "color": "#FF8C00",
        "isEncrypted": true
    }
}

Erzwingen von Berechtigungen während der Abfrage

Remote-SharePoint-Wissensquellen können SharePoint-Berechtigungen während der Abfrage erzwingen. Um diese Filterung zu aktivieren, schließen Sie das Zugriffstoken des Endbenutzers in die Abrufanforderung ein. Das Abrufmodul übergibt das Token an die Copilot Abruf-API, die SharePoint abfragt und nur Inhalte zurückgibt, auf die der Benutzer Zugriff hat. SharePoint-Berechtigungen und Microsoft-Purview-Sensitivitätslabels werden berücksichtigt.

Remote-SharePoint verwendet keinen separaten Foundry IQ-Index, sodass Sie keine Berechtigungen für die Aufnahmezeit konfigurieren müssen. Füllen Sie die Voraussetzungen aus, und schließen Sie das Token des Benutzers für jede Abrufanforderung ein.

Anweisungen zum Übergeben des Tokens finden Sie in Berechtigungen bei der Abfrage erzwingen (Vorschau).

Löschen einer Wissensquelle

Bevor Sie eine Wissensquelle löschen können, müssen Sie alle Knowledge Basen löschen, die darauf verweisen, oder die Knowledge Base-Definition aktualisieren, um den Verweis zu entfernen. Für Wissensquellen, die eine Index- und Indexerpipeline generieren, werden auch alle generierten Objekte gelöscht. Wenn Sie jedoch einen vorhandenen Index zum Erstellen einer Wissensquelle verwendet haben, wird Ihr Index nicht gelöscht.

Wenn Sie versuchen, eine verwendete Wissensquelle zu löschen, schlägt die Aktion fehl und gibt eine Liste der betroffenen Wissensdatenbanken zurück.

So löschen Sie eine Wissensquelle:

  1. Erhalten Sie eine Liste aller Wissensdatenbanken in Ihrem Foundry IQ-Dienst.

    using Azure.Search.Documents.Indexes;
    
    var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);
    var knowledgeBases = indexClient.GetKnowledgeBasesAsync();
    
    Console.WriteLine("Knowledge Bases:");
    
    await foreach (var kb in knowledgeBases)
    {
        Console.WriteLine($"  - {kb.Name}");
    }
    

    Reference:SearchIndexClient

    Eine Beispielantwort könnte wie folgt aussehen:

     {
         "@odata.context": "https://my-search-service.search.windows.net/$metadata#knowledgebases(name)",
         "value": [
         {
             "name": "my-kb"
         },
         {
             "name": "my-kb-2"
         }
         ]
     }
    
  2. Rufen Sie eine individuelle Wissensbasisdefinition ab, um nach Wissensquellenverweise zu suchen.

    using Azure.Search.Documents.Indexes;
    using System.Text.Json;
    
    var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);
    
    // Specify the knowledge base name to retrieve
    string kbNameToGet = "earth-knowledge-base";
    
    // Get a specific knowledge base definition
    var knowledgeBaseResponse = await indexClient.GetKnowledgeBaseAsync(kbNameToGet);
    var kb = knowledgeBaseResponse.Value;
    
    // Serialize to JSON for display
    string json = JsonSerializer.Serialize(kb, new JsonSerializerOptions { WriteIndented = true });
    Console.WriteLine(json);
    

    Reference:SearchIndexClient

    Eine Beispielantwort könnte wie folgt aussehen:

     {
       "Name": "earth-knowledge-base",
       "KnowledgeSources": [
         {
           "Name": "earth-knowledge-source"
         }
       ],
       "Models": [
         {}
       ],
       "RetrievalReasoningEffort": {},
       "OutputMode": {},
       "ETag": "\u00220x8DE278629D782B3\u0022",
       "EncryptionKey": null,
       "Description": null,
       "RetrievalInstructions": null,
       "AnswerInstructions": null
     }
    
  3. Löschen Sie entweder die Wissensdatenbank, oder aktualisieren Sie, wenn Sie über mehrere Wissensquellen verfügen, die Wissensbasis, um die Quelle zu entfernen. In diesem Beispiel wird das Löschen gezeigt.

    using Azure.Search.Documents.Indexes;
    var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);
    
    await indexClient.DeleteKnowledgeBaseAsync(knowledgeBaseName);
    System.Console.WriteLine($"Knowledge base '{knowledgeBaseName}' deleted successfully.");
    

    Reference:SearchIndexClient

  4. Löschen Sie die Wissensquelle.

    await indexClient.DeleteKnowledgeSourceAsync(knowledgeSourceName);
    System.Console.WriteLine($"Knowledge source '{knowledgeSourceName}' deleted successfully.");
    

    Reference:SearchIndexClient

  1. Erhalten Sie eine Liste aller Wissensbasen auf Ihrem Foundry IQ Service.

    # Get knowledge bases
    from azure.core.credentials import AzureKeyCredential
    from azure.search.documents.indexes import SearchIndexClient
    
    index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))
    
    print("Knowledge Bases:")
    for kb in index_client.list_knowledge_bases():
        print(f"  - {kb.name}")
    

    Reference:SearchIndexClient

    Eine Beispielantwort könnte wie folgt aussehen:

     {
         "@odata.context": "https://my-search-service.search.windows.net/$metadata#knowledgebases(name)",
         "value": [
         {
             "name": "my-kb"
         },
         {
             "name": "my-kb-2"
         }
         ]
     }
    
  2. Rufen Sie eine individuelle Wissensbasisdefinition ab, um nach Wissensquellenverweise zu suchen.

    # Get a knowledge base definition
    from azure.core.credentials import AzureKeyCredential
    from azure.search.documents.indexes import SearchIndexClient
    
    index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))
    kb = index_client.get_knowledge_base("knowledge_base_name")
    print(kb)
    

    Reference:SearchIndexClient

    Eine Beispielantwort könnte wie folgt aussehen:

     {
       "name": "my-kb",
       "description": null,
       "retrievalInstructions": null,
       "answerInstructions": null,
       "outputMode": null,
       "knowledgeSources": [
         {
           "name": "my-blob-ks"
         }
       ],
       "models": [],
       "encryptionKey": null,
       "retrievalReasoningEffort": {
         "kind": "low"
       }
     }
    
  3. Löschen Sie entweder die Wissensdatenbank, oder aktualisieren Sie, wenn Sie über mehrere Wissensquellen verfügen, die Wissensbasis, um die Quelle zu entfernen. In diesem Beispiel wird das Löschen gezeigt.

    # Delete a knowledge base
    from azure.core.credentials import AzureKeyCredential 
    from azure.search.documents.indexes import SearchIndexClient
    
    index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))
    index_client.delete_knowledge_base("knowledge_base_name")
    print(f"Knowledge base deleted successfully.")
    

    Reference:SearchIndexClient

  4. Löschen Sie die Wissensquelle.

    # Delete a knowledge source
    from azure.core.credentials import AzureKeyCredential 
    from azure.search.documents.indexes import SearchIndexClient
    
    index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))
    index_client.delete_knowledge_source("knowledge_source_name")
    print(f"Knowledge source deleted successfully.")
    

    Reference:SearchIndexClient

  1. Erhalten Sie eine Liste aller Wissensbasen auf Ihrem Foundry IQ Service.

    ### Get knowledge bases
    GET {{search-url}}/knowledgebases?api-version={{api-version}}&$select=name
    Authorization: Bearer {{token}}
    

    Referenz:Wissensdatenbanken - Liste

    Eine Beispielantwort könnte wie folgt aussehen:

     {
         "@odata.context": "https://my-search-service.search.windows.net/$metadata#knowledgebases(name)",
         "value": [
         {
             "name": "my-kb"
         },
         {
             "name": "my-kb-2"
         }
         ]
     }
    
  2. Rufen Sie eine individuelle Wissensbasisdefinition ab, um nach Wissensquellenverweise zu suchen.

    ### Get a knowledge base definition
    GET {{search-url}}/knowledgebases('{{knowledge-base-name}}')?api-version={{api-version}}
    Authorization: Bearer {{token}}
    

    Referenz:Wissensdatenbanken – Abrufen

    Eine Beispielantwort könnte wie folgt aussehen:

     {
       "name": "my-kb",
       "description": null,
       "retrievalInstructions": null,
       "answerInstructions": null,
       "outputMode": null,
       "knowledgeSources": [
         {
           "name": "my-blob-ks"
         }
       ],
       "models": [],
       "encryptionKey": null,
       "retrievalReasoningEffort": {
         "kind": "low"
       }
     }
    
  3. Löschen Sie entweder die Wissensdatenbank, oder aktualisieren Sie, wenn Sie über mehrere Wissensquellen verfügen, die Wissensbasis, um die Quelle zu entfernen. In diesem Beispiel wird das Löschen gezeigt.

    ### Delete a knowledge base
    DELETE {{search-url}}/knowledgebases('{{knowledge-base-name}}')?api-version={{api-version}}
    Authorization: Bearer {{token}}
    

    Referenz:Knowledge Bases - Löschen

  4. Löschen Sie die Wissensquelle.

    ### Delete a knowledge source
    DELETE {{search-url}}/knowledgesources('{{knowledge-source-name}}')?api-version={{api-version}}
    Authorization: Bearer {{token}}
    

    Referenz:Wissensquellen - Löschen