検索

このページでは、開発者向けスコープ指定ヘルパーと、具体的なOracle検索結果タイプを示します。

スコープ

クラス oracleagentmemory.apis.scope.Scope

ベース: object

情報の挿入または検索のスコープを表します。

• パラメータ:
  • user_id str | None
  • agent_id str | None
  • thread_id str | None

user_id

エンドユーザーのID。NOT_SET_MARKERは、フィールドが省略され、操作固有のデフォルトによって解決される必要があることを意味します。明示的なNoneは、操作固有のルールによって保持および解釈されます。OracleAgentMemory.search()などの上位レベルのクライアントAPIでは、ユーザー・スコープを明示する必要がある場合があります。これらのAPIでは、Noneを使用して、スコープなしレコードのみをターゲットにできます。

• タイプ: str | None

エージェントID

エージェントID NOT_SET_MARKERは、フィールドが省略され、操作固有のデフォルトによって解決される必要があることを意味します。明示的なNoneは、操作固有のルールによって保持および解釈されます。

• タイプ: str | None

スレッドID

スレッドID。NOT_SET_MARKERは、フィールドが省略され、操作固有のデフォルトによって解決される必要があることを意味します。明示的なNoneは、操作固有のルールによって保持および解釈されます。

• タイプ: str | None

クラス oracleagentmemory.apis.searchscope.SearchScope

ベース: Scope

検索問合せのスコープを表すため、返される内容を制限します。

• パラメータ:
  • 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。解決されたexact_user_match値がTrueの場合、このIDはNoneも含めて完全に一致します。Falseの場合、ユーザー・ディメンションは制約されません。NOT_SET_MARKERは、操作固有のデフォルトに置き換えられます。OracleAgentMemory.search()などの上位レベルのクライアントAPIでは、ユーザー・スコープを明示する必要がある場合があります。これらのAPIでは、exact_user_matchがTrueに解決された場合、Noneはスコープなしレコードのみをターゲットとします。

• タイプ: str | None

エージェントID

エージェントID 解決されたexact_agent_match値がTrueの場合、このIDはNoneも含めて完全に一致します。Falseの場合、エージェント・ディメンションは制約されません。NOT_SET_MARKERは、スコープを使用する操作に応じてデフォルト値に置き換えられます。

• タイプ: str | None

スレッドID

スレッドID。解決されたexact_thread_match値がTrueの場合、このIDはNoneも含めて完全に一致します。Falseの場合、スレッド・ディメンションは制約されません。NOT_SET_MARKERは、スコープを使用する操作に応じてデフォルト値に置き換えられます。

• タイプ: str | None

完全一致

解決されたuser_idと完全に一致するかどうか。Trueは、Noneを含む厳密に一致します。Falseは、ユーザー・ディメンションを制約なしのままにします。NOT_SET_MARKERは、操作に応じてデフォルトで置き換えられます。OracleAgentMemory.search()などの上位レベルのクライアントAPIでは、これをTrueのままにする必要がある場合があります。

• タイプ: bool

完全一致エージェント

解決されたagent_idと完全に一致するかどうか。Trueは、Noneを含む厳密に一致します。Falseは、エージェント・ディメンションを制約なしのままにします。NOT_SET_MARKERは、操作に応じてデフォルトで置き換えられます。

• タイプ: bool

完全スレッド一致

解決されたthread_idと完全に一致するかどうか。Trueは、Noneを含む厳密に一致します。Falseは、スレッド・ディメンションを制約なしのままにします。NOT_SET_MARKERは、操作に応じてデフォルトで置き換えられます。

• タイプ: bool

結果

クラス oracleagentmemory.core.OracleSearchResult

ベース: SearchResult

Oracleスレッドによって返された検索結果。

• パラメータ:
  • distance float– 問合せベクトルからの距離(小さい方が良い)。
  • record Record– 永続化されたエントリに関するメタデータ情報を含むレコードオブジェクト。
  • id str | None– 格納されたレコードに関連付けられたオプションの識別子。

プロパティ content

• 戻りタイプ: str
• 説明:一致したレコードのプライマリ・テキスト・コンテンツを返します。

property formatted_content

• 戻りタイプ: str
• 説明:プロンプトで使用されるデフォルトのXMLセーフ・レンダリングを返します。

プロパティー id

• 戻りタイプ: str

  なし

• 説明:一致したレコードの安定した識別子(使用可能な場合)を返します。

property metadata

• 戻りタイプ: dict[str、 Any]

  なし

• 説明:レコード・メタデータ(使用可能な場合)を返します。

property record

• 戻りタイプ: レコード
• 説明:一致したレコードを返します。

メソッド render_formatted_content

結果コンテンツの構造化されたXMLセーフな表現を返します。

• パラメータ:
  • show_thread_id bool
  • show_distance bool
  • show_timestamp bool
  • show_role bool
  • show_user_id bool
  • show_agent_id bool
• 戻り型: str

property timestamp

• 戻りタイプ: str

  なし

• 説明:レコード・タイムスタンプ(使用可能な場合)を返します。