Rechercher

Cette page présente les aides à la définition de la portée destinées aux développeurs ainsi que le type de résultat de recherche Oracle concret.

Portées

classe oracleagentmemory.apis.scope.Scope

Bases : object

Représente une portée pour l'insertion ou la recherche d'informations.

• Paramètres:
  • user_id str | None
  • agent_id str | None
  • thread_id str | None

user_id

ID d'utilisateur final. NOT_SET_MARKER signifie que le champ a été omis et doit être résolu par la valeur par défaut propre à l'opération. L'expression None explicite est conservée et interprétée par les règles propres à l'opération. Les API client de niveau supérieur telles que OracleAgentMemory.search() peuvent exiger que la portée utilisateur soit explicite. Dans ces API, None peut être utilisé pour cibler uniquement les enregistrements non ciblés.

• Type : str | None

agent_id

ID d'agent. NOT_SET_MARKER signifie que le champ a été omis et doit être résolu par la valeur par défaut propre à l'opération. L'expression None explicite est conservée et interprétée par les règles propres à l'opération.

• Type : str | None

id_thread

ID de thread. NOT_SET_MARKER signifie que le champ a été omis et doit être résolu par la valeur par défaut propre à l'opération. L'expression None explicite est conservée et interprétée par les règles propres à l'opération.

• Type : str | None

classe oracleagentmemory.apis.searchscope.SearchScope

Bases : Scope

Représente la portée d'une requête de recherche et limite donc ce qui peut être renvoyé.

• Paramètres:
  • 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

ID d'utilisateur final. Lorsque la valeur exact_user_match résolue est True, cet ID correspond exactement, y compris None. Lorsque la valeur est False, la dimension utilisateur n'est pas contrainte. NOT_SET_MARKER est remplacé par une valeur par défaut propre à l'opération. Les API client de niveau supérieur telles que OracleAgentMemory.search() peuvent exiger que la portée utilisateur soit explicite. Dans ces API, None cible uniquement les enregistrements sans portée lorsque exact_user_match est résolu en True.

• Type : str | None

agent_id

ID d'agent. Lorsque la valeur exact_agent_match résolue est True, cet ID correspond exactement, y compris None. Lorsque la valeur est False, la dimension d'agent n'est pas contrainte. NOT_SET_MARKER est remplacé par une valeur par défaut en fonction de l'opération utilisant la portée.

• Type : str | None

id_thread

ID de thread. Lorsque la valeur exact_thread_match résolue est True, cet ID correspond exactement, y compris None. Lorsque la valeur est False, la dimension de thread n'est pas contrainte. NOT_SET_MARKER est remplacé par une valeur par défaut en fonction de l'opération utilisant la portée.

• Type : str | None

exact_user_match

Indique si la correspondance doit être exacte avec le fichier user_id résolu. True correspond exactement, y compris None. False laisse la dimension utilisateur sans contrainte. NOT_SET_MARKER est remplacé par une valeur par défaut en fonction de l'opération. Les API client de niveau supérieur telles que OracleAgentMemory.search() peuvent exiger qu'elles restent True.

• Type : booléen

exact_agent_match

Indique si la correspondance doit être exacte avec le fichier agent_id résolu. True correspond exactement, y compris None. False laisse la dimension d'agent sans contrainte. NOT_SET_MARKER est remplacé par une valeur par défaut en fonction de l'opération.

• Type : booléen

correspondance_thread_exact

Indique si la correspondance doit être exacte avec le fichier thread_id résolu. True correspond exactement, y compris None. False laisse la dimension de thread sans contrainte. NOT_SET_MARKER est remplacé par une valeur par défaut en fonction de l'opération.

• Type : booléen

Résultats

classe oracleagentmemory.core.OracleSearchResult

Bases : SearchResult

Résultat de la recherche renvoyé par un thread Oracle.

• Paramètres:
  • distance float : distance par rapport au vecteur de requête (plus petite est préférable).
  • record Record – Objet d'enregistrement contenant les informations de métadonnées relatives à l'entrée persistante.
  • id str | None : identificateur facultatif associé à l'enregistrement stocké.

propriété content

• Type de retour : str
• Description : renvoie le contenu textuel principal de l'enregistrement mis en correspondance.

propriété formatted_content

• Type de retour : str
• Description : renvoie le rendu sécurisé au format XML par défaut utilisé dans les invites.

propriété id

• Type de retour : str

  aucun

• Description : Renvoie l'identifiant stable de l'enregistrement mis en correspondance, lorsqu'il est disponible.

propriété metadata

• Type de retour : dict[str, Any]

  aucun

• Description : renvoie les métadonnées d'enregistrement, le cas échéant.

propriété record

• Type renvoyé : Enregistrement
• Description : renvoie l'enregistrement correspondant.

méthode render_formatted_content

Renvoyer une représentation structurée et sécurisée au format XML du contenu du résultat.

• Paramètres:
  • show_thread_id bool
  • show_distance bool
  • show_timestamp bool
  • show_role bool
  • show_user_id bool
  • show_agent_id bool
• Type de retour : str

propriété timestamp

• Type de retour : str

  aucun

• Description : renvoie l'horodatage de l'enregistrement, le cas échéant.