Inhaltsbezogene Speicher-APIs (CAS )

Liste aller REST-API-Referenzen für den CAS-Dienst.

Autorisierung für REST-APIs

Für die Authentifizierung von REST-APIs müssen Sie sicherstellen, dass Sie ein gültiges OpenShift® Container Platform überbringer-Token im Autorisierungs-Header:

Abrufen des Tokens:
1. Gehen Sie zur Konsole OpenShift.
2. Klicken Sie auf der daraufhin angezeigten Seite auf den Link Token anzeigen.
3. Kopieren Sie auf der Seite Your API token is den Token-Wert aus dem Abschnitt Log in with this token.
  Hinweis: Für die Authentifizierung von REST-APIs, wenn ein externer Identitätsanbieter konfiguriert ist, stellen Sie sicher, dass Sie ein gültiges Inhaber-Token des Identitätsanbieters im Autorisierungs-Header haben.
Gehen Sie in Ihrem Browser auf swagger - https://<fusion url>/api/v1/querysearch/docs.
Das Swagger-Dokument spezifiziert die Liste der Ressourcen, die in der REST-API verfügbar sind, und die Operationen, die für diese Ressourcen aufgerufen werden können. Das Swagger-Dokument spezifiziert auch die Liste der Parameter für eine Operation, einschließlich des Namens und des Typs der Parameter und Informationen über akzeptable Werte für diese Parameter.
Auf der FastAPI seite, klicken Sie auf Autorisieren.
Geben Sie im Fenster Verfügbare Berechtigungen einen Wert für HTTPBearer ein.
Klicken Sie auf Autorisieren.

APIs von Swagger ausprobieren

Weitere Informationen über Swagger-Dokumente finden Sie unter https://fusionconsoleurl/api/v1/querysearch/docs# oder gehen Sie in der Benutzeroberfläche zu Domains > View Search APIs.

Erweitern Sie in Swagger die API und klicken Sie auf " Try it out".

/Tabellen

Beschreibung: Sie gibt eine "Tabellen"-Abfrage des Dokumentenprozessors zurück, auf die Sie Zugriff haben.

Methode: ERLANGEN

Verwendung: Swagger überprüfen.

/semantische_suche

Beschreibung: Findet die exakten Wörter und nutzt die Verarbeitung natürlicher Sprache (NLP) und maschinelles Lernen, um Ergebnisse zu finden, die semantisch relevant sind. Wenn Sie keinen Zugriff auf eine bestimmte Domäne haben, gibt die API einen Fehler 403 (Ungültiger Zugriff) aus. Wenn die Sicherheit auf Dateiebene aktiviert ist, werden die semantischen Suchergebnisse auf die Dateien beschränkt, die der CAS-Anfragebenutzer im IBM Scale-Dateisystem lesen darf.

Methode: VERÖFFENTLICHEN

Parameter

Parameter: Typ	Beschreibung
"Abfrage": string	Die natürlichsprachliche Frage, die vom Einbettungsmodell verwendet wird, um eine Liste relevanter Textausschnitte aus den eingelesenen Dokumenten zu erstellen.
"Tabelle": Zeichenkette	Name eines bestimmten Dokumentenprozessors, der Dokumente aus einem bestimmten Bereich aufgenommen hat.
"Grenze": int	Maximale Anzahl der zurückgegebenen Ergebnisse, Standardwert ist 5.
"enable_source": boolescher Wert	Wenn "true", werden alle Quelleninformationen zum Dokument zurückgegeben.
"enable_content_metadata": boolescher Wert	Wenn "true", werden alle Metadaten über das betreffende Dokument zurückgegeben.

Verwendung: Überprüfen Sie die Angeberei.

Beispiel für einen CLI-Chatbot für Endbenutzer: Der CLI-gestützte Chatbot ermöglicht einen sicheren, authentifizierten Zugriff auf Content-Aware Storage über eine konversationelle CLI, die von LLMs wie IBM watsonx Granite, Open AI, NVIDIA NIM und Ollama unterstützt wird. Sie nutzt die semantischen APIs von CAS, um effiziente, KI-gestützte Erkenntnisse zu liefern und RAG-Workflows mit verbesserter Leistung, Sicherheit und Effizienz zu beschleunigen.; Weitere Informationen finden Sie in dem Referenzbeispiel in GitHub.