Suchen

Auf dieser Seite werden die Scoping-Helfer für Entwickler zusammen mit dem konkreten Oracle-Suchergebnistyp angezeigt.

Geltungsbereiche

Klasse oracleagentmemory.apis.scope.Scope

Basis: object

Stellt einen Geltungsbereich für das Einfügen oder Suchen von Informationen dar.

• Parameter:
  • user_id str | None
  • agent_id str | None
  • thread_id str | None

user_id

Endbenutzer-ID. NOT_SET_MARKER bedeutet, dass das Feld ausgelassen wurde und durch den betriebsspezifischen Standardwert aufgelöst werden sollte. Explizites None wird beibehalten und von den Vorgangsspezifischen Regeln interpretiert. Für höhere Client-APIs wie OracleAgentMemory.search() muss der Benutzergeltungsbereich möglicherweise explizit angegeben werden. In diesen APIs kann None nur für nicht kopierte Datensätze verwendet werden.

• Typ: str | Keine

agent_id

Agent-ID. NOT_SET_MARKER bedeutet, dass das Feld ausgelassen wurde und durch den betriebsspezifischen Standardwert aufgelöst werden sollte. Explizites None wird beibehalten und von den operationsspezifischen Regeln interpretiert.

• Typ: str | Keine

Thread-Kennung

Thread-ID. NOT_SET_MARKER bedeutet, dass das Feld ausgelassen wurde und durch den betriebsspezifischen Standardwert aufgelöst werden sollte. Explizites None wird beibehalten und von den operationsspezifischen Regeln interpretiert.

• Typ: str | Keine

Klasse oracleagentmemory.apis.searchscope.SearchScope

Basis: Scope

Stellt den Geltungsbereich für eine Suchabfrage dar und schränkt daher ein, was zurückgegeben werden kann.

• Parameter:
  • user_id str | None
  • agent_id str | None
  • thread_id str | None
  • exact_user_match bool
  • exact_agent_match bool
  • exact_thread_match bool

user_id

Endbenutzer-ID. Wenn der aufgelöste exact_user_match-Wert True lautet, wird diese ID genau abgeglichen, einschließlich None. Wenn es sich um False handelt, ist die Benutzerdimension uneingeschränkt. NOT_SET_MARKER wird durch einen betriebsspezifischen Standardwert ersetzt. Für höhere Client-APIs wie OracleAgentMemory.search() muss der Benutzergeltungsbereich möglicherweise explizit angegeben werden. In diesen APIs zielt None nur auf nicht kopierte Datensätze ab, wenn exact_user_match in True aufgelöst wird.

• Typ: str | Keine

agent_id

Agent-ID. Wenn der aufgelöste exact_agent_match-Wert True lautet, wird diese ID genau abgeglichen, einschließlich None. Wenn es sich um False handelt, ist die Agent-Dimension uneingeschränkt. NOT_SET_MARKER wird je nach Vorgang, der den Geltungsbereich verwendet, durch einen Standardwert ersetzt.

• Typ: str | Keine

Thread-Kennung

Thread-ID. Wenn der aufgelöste exact_thread_match-Wert True lautet, wird diese ID genau abgeglichen, einschließlich None. Wenn es sich um False handelt, ist die Threaddimension uneingeschränkt. NOT_SET_MARKER wird je nach Vorgang, der den Geltungsbereich verwendet, durch einen Standardwert ersetzt.

• Typ: str | Keine

genaue_Benutzer_übereinstimmung

Gibt an, ob die aufgelöste user_id exakt übereinstimmen soll. True stimmt genau überein, einschließlich None. Bei False ist die Benutzerdimension uneingeschränkt. NOT_SET_MARKER wird je nach Vorgang durch einen Standardwert ersetzt. Für höhere Client-APIs wie OracleAgentMemory.search() muss dies möglicherweise True bleiben.

• Typ: boolesch

exact_agent_match

Gibt an, ob die aufgelöste agent_id exakt übereinstimmen soll. True stimmt genau überein, einschließlich None. Mit False ist die Agent-Dimension nicht eingeschränkt. NOT_SET_MARKER wird je nach Vorgang durch einen Standardwert ersetzt.

• Typ: boolesch

genaue_Thread-Übereinstimmung

Gibt an, ob die aufgelöste thread_id exakt übereinstimmen soll. True stimmt genau überein, einschließlich None. Bei False ist die Threaddimension uneingeschränkt. NOT_SET_MARKER wird je nach Vorgang durch einen Standardwert ersetzt.

• Typ: boolesch

Ergebnisse

Klasse oracleagentmemory.core.OracleSearchResult

Basen: SearchResult

Von einem Oracle-Thread zurückgegebenes Suchergebnis.

• Parameter:
  • Abstand float: Abstand zum Abfragevektor (kleiner ist besser).
  • record Record: Ein Datensatzobjekt mit den Metadateninformationen zum persistenten Eintrag.
  • id str | None: Optionale ID, die mit dem gespeicherten Datensatz verknüpft ist.

Eigenschaft content

• Rückgabetyp: str
• Beschreibung: Gibt den primären Textinhalt für den übereinstimmenden Datensatz zurück.

Eigenschaft formatted_content

• Rückgabetyp: str
• Beschreibung: Gibt das standardmäßige XML-sichere Rendering zurück, das in Prompts verwendet wird.

Eigenschaft id

• Rückgabetyp: str

  Kein Wert

• Beschreibung: Gibt die stabile ID des abgeglichenen Datensatzes zurück, sofern verfügbar.

Eigenschaft metadata

• Rückgabetyp: dict[str, Any]

  Kein Wert

• Beschreibung: Gibt die Metadaten des Datensatzes zurück, sofern verfügbar.

Eigenschaft record

• Rückgabetyp: Datensatz
• Beschreibung: Gibt den zugeordneten Datensatz zurück.

Methode render_formatted_content

Gibt eine strukturierte, XML-sichere Darstellung des Ergebnisinhalts zurück.

• Parameter:
  • show_thread_id bool
  • show_distance bool
  • show_timestamp bool
  • show_role bool
  • show_user_id bool
  • show_agent_id bool
• Rückgabetyp: str

Eigenschaft timestamp

• Rückgabetyp: str

  Kein Wert

• Beschreibung: Gibt den Zeitstempel des Datensatzes zurück, sofern verfügbar.