レコード
このページには、Oracle Agent Memoryストアおよび検索APIによって返されるレコード値タイプが表示されます。
ベース・レコード
クラス oracleagentmemory.apis.records.Record
ベース: object
メモリー・ストアおよび検索結果によって返されるベース永続レコード。
- パラメータ:
- id
str– 格納されたレコードの安定した識別子。 - record_type
str–"message"、"memory"、"guideline"、"fact"、"preference"、"thread"、"user_profile"、"agent_profile"、"thread_summary"などの論理レコード・タイプ。 - content
str | None– レコード用に格納されるオプションのテキスト・ペイロード。 - timestamp
str | None– レコード用に保存されたタイムスタンプ。これは、レコードが作成された時間を表します。コール元タイムスタンプが指定されていない場合、ストアは、レコードがストアに追加された時間を使用します。 - metadata
MetadataValue– レコードにアタッチされたオプションのJSONのようなメタデータ・ペイロード。 - status
RecordStatus– レコードのライフサイクル・ステータス。デフォルトはRecordStatus.VALIDです。 - linked_results
Sequence tuple[[RecordRelation, Record]]– グラフ展開検索で添付された関連レコード。各アイテムには、格納されたリレーションと、そのアイテムを介して到達したレコードが含まれます。グラフ展開検索の外部で返されたレコードには、空のシーケンスがあります。
- id
レコード・ステータス
クラス oracleagentmemory.apis.records.RecordStatus
ベース: str、Enum
永続レコードのライフサイクル・ステータス。
VALIDは通常のアクティブ・ステータスです。INVALIDは、アプリケーションが取得からレコードを除外できるようにしながら、履歴使用のためにレコードを保持します。
無効な = 'INVALID'
有効な = 'VALID'
スコープ付きレコード
クラス oracleagentmemory.apis.records.ScopedRecord
ベース: Record
公開スコープ識別子を公開する永続レコード。
ScopedRecordは、パブリック・シェイプにthread_id、user_id、agent_idなどの範囲指定属性が含まれるレコード・タイプの共有ベース・クラスです。一般的な例としては、スレッド、メッセージおよびメモリーがあります。
- パラメータ:
- thread_id
str | None– レコードとともに格納されるオプションのスレッドスコープ識別子。 - user_id
str | None– レコードとともに格納されるオプションのユーザースコープ識別子。 - agent_id
str | None– レコードとともに格納されるオプションのエージェントスコープ識別子。 - id
str - record_type
str - コンテンツ
str | None - タイムスタンプ
str | None - メタデータ
MetadataValue - status
RecordStatus - linked_results
Sequence tuple[[RecordRelation, Record]]
- thread_id
メッセージ・レコード
クラス oracleagentmemory.apis.records.MessageRecord
ベース: ScopedRecord
格納されたチャット・メッセージ・レコード。
contentは、メッセージ・コンテンツ・パートの文字列または順序付けられた順序のいずれかを受け入れます。
- パラメータ:
- role
str | None– メッセージに関連付けられたオプションのロール("user"や"assistant"など)。 - content
str | Sequence[MessageContent]– 直接構築用のメッセージ・テキスト、またはTextContentおよびImageContentパートの順序付きシーケンス。 - seq_no
int– メッセージのスレッド内のシーケンス番号を増加させ、安定している必要があります。ギャップは許可されます。スレッドの履歴の一部を取得するには、list_thread_messages()範囲境界とともに使用します。 - id
str - タイムスタンプ
str | None - メタデータ
MetadataValue - status
RecordStatus - linked_results
Sequence tuple[[RecordRelation, Record]] - thread_id
str | None - user_id
str | None - agent_id
str | None
- role
メモリー・レコード
クラス oracleagentmemory.apis.records.MemoryRecord
ベース: ScopedRecord
永続メモリー・レコード。
- パラメータ:
- id
str - コンテンツ
str | None - タイムスタンプ
str | None - メタデータ
MetadataValue - status
RecordStatus - linked_results
Sequence tuple[[RecordRelation, Record]] - thread_id
str | None - user_id
str | None - agent_id
str | None
- id
ガイドライン・レコード
クラス oracleagentmemory.apis.records.GuidelineRecord
ベース: MemoryRecord
一般的な記憶とは別に保存されたガイドライン・レコード。
- パラメータ:
- id
str - コンテンツ
str | None - タイムスタンプ
str | None - メタデータ
MetadataValue - status
RecordStatus - linked_results
Sequence tuple[[RecordRelation, Record]] - thread_id
str | None - user_id
str | None - agent_id
str | None
- id
ファクトレコード
クラス oracleagentmemory.apis.records.FactRecord
ベース: MemoryRecord
一般的な記憶とは別に格納されたファクト・レコード。
- パラメータ:
- id
str - コンテンツ
str | None - タイムスタンプ
str | None - メタデータ
MetadataValue - status
RecordStatus - linked_results
Sequence tuple[[RecordRelation, Record]] - thread_id
str | None - user_id
str | None - agent_id
str | None
- id
プリファレンス・レコード
クラス oracleagentmemory.apis.records.PreferenceRecord
ベース: MemoryRecord
一般的な記憶とは別に格納されるプリファレンス・レコード。
- パラメータ:
- id
str - コンテンツ
str | None - タイムスタンプ
str | None - メタデータ
MetadataValue - status
RecordStatus - linked_results
Sequence tuple[[RecordRelation, Record]] - thread_id
str | None - user_id
str | None - agent_id
str | None
- id
ユーザープロファイルレコード
クラス oracleagentmemory.apis.records.UserProfileRecord
ベース: Record
スコープなしユーザー・プロファイル・レコード。
- パラメータ:
- id
str - コンテンツ
str | None - タイムスタンプ
str | None - メタデータ
MetadataValue - status
RecordStatus - linked_results
Sequence tuple[[RecordRelation, Record]]
- id
エージェント・プロファイル・レコード
クラス oracleagentmemory.apis.records.AgentProfileRecord
ベース: Record
スコープなしエージェント・プロファイル・レコード。
- パラメータ:
- id
str - コンテンツ
str | None - タイムスタンプ
str | None - メタデータ
MetadataValue - status
RecordStatus - linked_results
Sequence tuple[[RecordRelation, Record]]
- id
イメージ・レコード
クラス oracleagentmemory.apis.records.ImageRecord
ベース: ScopedRecord
永続イメージ文書レコード。
イメージ・バイトはデフォルトで省略されます。有効範囲付きリストは、イメージ識別子の明示的な許可リストのバイトをロードできます。
- パラメータ:
- message_id
str | None– このイメージ部分を含むメッセージのオプション識別子。 - mime_type
ImageMimeType– イメージのMIMEタイプ。これは、レコードからbytesを省略した場合も含めて、常に必要です。 - bytes
builtins.bytes | None– 取得操作によってリクエストされた場合はイメージ・データ、それ以外の場合はNone。 - id
str - コンテンツ
str | None - タイムスタンプ
str | None - メタデータ
MetadataValue - status
RecordStatus - linked_results
Sequence tuple[[RecordRelation, Record]] - thread_id
str | None - user_id
str | None - agent_id
str | None
- message_id
スレッド・レコード
クラス oracleagentmemory.apis.records.ThreadRecord
ベース: ScopedRecord
スレッド・スコープのストア・レコード。
- パラメータ:
- id
str - コンテンツ
str | None - タイムスタンプ
str | None - メタデータ
MetadataValue - status
RecordStatus - linked_results
Sequence tuple[[RecordRelation, Record]] - thread_id
str | None - user_id
str | None - agent_id
str | None - runtime_config
dict[str, Any] | None - runtime_state
dict[str, Any] | None
- id
ヘルパー
oracleagentmemory.apis.records.build_record
格納された行の最も具体的なレコード実装を構築します。
- パラメータ:
- record_type
str– 標準のレコードタイプラベル。 - record_id
str– レコードの安定した公開識別子。 - content
str | dict[str, object] | Sequence[MessageContent] | None– オプションのレコード・ペイロード。メッセージ・レコードには、構造化されたメッセージ・コンテンツ部分の順序付きシーケンスを含めることもできます。 - thread_id
str | None– スコープ付きレコードタイプのオプションのスレッドスコープ識別子。 - user_id
str | None– スコープ付きレコードタイプのオプションのユーザースコープ識別子。 - agent_id
str | None– スコープ付きレコードタイプのエージェントスコープ識別子(オプション)。 - role
str | None– メッセージレコードにのみ使用されるオプションのチャット役割。 - seq_no
int | None– メッセージレコードには安定したメッセージシーケンス番号が必要です。他のレコード・タイプでは無視されます。 - timestamp
str | None– レコード用に保存されたタイムスタンプ。これは、レコードが作成された時期を表します。省略すると、ストアは、レコードがストアに追加された時間を使用します。 - metadata
dict[str, Any] | None– オプションのメタデータ・ペイロード。 - status
RecordStatus– レコードのライフサイクル・ステータス。デフォルトはRecordStatus.VALIDです。 - kwargs
Any– 特定のレコードタイプに対する追加のキーワード引数。
- record_type
- 戻り値:
record_typeで認識される最も具体的なレコード・クラス。 - 返品タイプ: レコード