Entwickler-Tools und APIs¶
Willkommen in der Entwicklerdokumentation von Rememberizer. Dieser Abschnitt bietet umfassende Informationen zu den Tools, APIs und Integrationsmöglichkeiten, die Entwicklern zur Verfügung stehen, die mit den semantischen Such- und Wissensmanagement-Funktionen von Rememberizer arbeiten.
Übersicht über die Entwicklerfunktionen von Rememberizer¶
Rememberizer bietet eine robuste Sammlung von Entwicklerwerkzeugen, die Ihnen helfen, leistungsstarke semantische Suchfunktionen in Ihre Anwendungen zu integrieren. Als Entwickler können Sie:
- Zugriff auf semantische Suche über RESTful APIs mit Vektor-Einbettungstechnologie
- Rememberizer in Ihre eigenen Anwendungen integrieren mit OAuth2 oder API-Schlüsseln
- Benutzerdefinierte Anwendungen erstellen, die auf den Wissensbasen der Benutzer basieren
- Vektor-Speicher erstellen für spezialisierte semantische Suchdatenbanken
- Verbindung zu KI-Modellen herstellen, einschließlich OpenAI GPTs und LangChain
Kernkomponenten¶
Die Architektur von Rememberizer besteht aus mehreren Schlüsselkomponenten, die zusammenarbeiten, um ein umfassendes Wissensmanagement- und semantisches Suchsystem bereitzustellen:
| Komponente | Beschreibung |
|---|---|
| API-Dienst | RESTful-Endpunkte, die Zugriff auf die Funktionen von Rememberizer bieten |
| Authentifizierungssystem | OAuth2- und API-Schlüsselverwaltung für sicheren Zugriff |
| Vektor-Datenbanken | Spezialisierte Datenbanken, die für die semantische Suche optimiert sind |
| Mementos | Konfigurierbare Zugriffsfilter für Wissensquellen |
| Integrationen | Verbindungen zu externen Datenquellen (Slack, Google Drive usw.) |
| Dokumentenverarbeitung | Systeme zum Chunking, Einbetten und Indizieren von Inhalten |
Authentifizierungsoptionen¶
Rememberizer unterstützt zwei primäre Authentifizierungsmethoden:
-
OAuth2-Authentifizierung: Für Anwendungen, die Zugriff auf spezifische Benutzerdaten und Dokumente benötigen. Dieser Ablauf ermöglicht es Benutzern, Ihre Anwendung zu autorisieren, um auf ihr Wissen über konfigurierbare Mementos zuzugreifen.
-
API-Schlüssel-Authentifizierung: Für den direkten Zugriff auf Vektor-Speicher oder gemeinsame Wissensdatenbanken, ohne den OAuth-Ablauf. Dies bietet einen einfacheren Integrationsweg für Anwendungen, die keine benutzerspezifischen Daten benötigen.
Entwicklerdokumentation Fahrplan¶
Diese Dokumentation ist so organisiert, dass Sie schnell die Informationen finden, die Sie benötigen:
Erste Schritte¶
- Registrierung von Rememberizer-Apps - Entwickleranwendungen erstellen
- Autorisierung von Rememberizer-Apps - OAuth2-Autorisierung implementieren
- Registrierung und Verwendung von API-Schlüsseln - Mit der API-Schlüssel-Authentifizierung arbeiten
Kernfunktionen¶
- Vektor-Speicher - Erstellen und Verwalten von semantischen Suchdatenbanken
- Einen Rememberizer GPT erstellen - Integration mit OpenAIs GPT-Modellen
- LangChain-Integration - Verbindung mit LangChain-Anwendungen
- Integrationsmuster für Unternehmen - Architekturmuster für Unternehmensbereitstellungen
API-Referenz¶
- API-Dokumentation - Umfassende API-Referenz
- Authentifizierung, Suche, Dokumentenverwaltung und weitere spezialisierte Endpunkte
Beispiele und Beispielcode¶
- Talk-to-Slack Beispiel-Webanwendung - Beispielintegration
Beispiel-Integrationsfluss¶
Hier ist ein typischer Ablauf zur Integration von Rememberizer in Ihre Anwendung:
- Registrieren Sie eine Anwendung im Rememberizer-Entwicklerportal
- Implementieren Sie die OAuth2-Authentifizierung in Ihrer Anwendung
- Fordern Sie Zugriff auf die Benutzererinnerungen an
- Führen Sie API-Aufrufe durch, um Wissen zu suchen und abzurufen
- Verarbeiten und zeigen Sie die Ergebnisse in Ihrer Anwendung an
// Beispiel: Authentifizierte API-Anfrage mit OAuth-Token
async function searchUserKnowledge(query, token) {
const response = await fetch('https://api.rememberizer.ai/api/v1/search/', {
method: 'POST',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({ query })
});
return response.json();
}
Nächste Schritte¶
Beginnen Sie mit der Registrierung Ihrer Anwendung, um Client-Anmeldeinformationen zu erhalten, und erkunden Sie dann die API-Dokumentation, um mehr über die verfügbaren Endpunkte zu erfahren.