AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。
See how MongoDB 9.0 delivers up to 2x higher throughput.
MongoDB Branding Shape
Register now >
Docs Menu
Docs Home
/ /
Agent- engine-memory
Docs Home
/ /
JavaScript SDK
/
Agent- engine-memory
Docs Home
/
Atlas エージェント エンジン
/
Atlas Agent Engine SDK
/
JavaScript SDK
/
Agent- engine-memory

@mongodb-js/agent- engine-sdk-memory

目次

クラス

メモリ

パブリックでトランスポートフリーのメモリファサード。

Constructor

new Memory(opts?): Memory;

パラメーター

Parameter
タイプ

opts

`MemoryOptions "#memoryoptions",gt,`__

戻り値

`Memory <#memory>`__

メソッド

bind()
bind(ctx): Memory;

このハンドルをミューテーションせずに、ctx にスコープが設定された新しいメモリを返します。

パラメーター

Parameter
タイプ

ctx

`MemoryRequestContext "#memoryrequestcontext",`__

戻り値

`Memory <#memory>`__

buildContext()
buildContext(args): Promise<{
  formatted_context: string | Record<string, unknown>[];
  metadata: {
     memory_counts: Record<string, number>;
     timing: Record<string, number>;
     token_count: number;
  };
  selected_memories?: object[] | null;
}>;

メモリ型間で統合されたメモリ コンテキストを構築します。

パラメーター

Parameter
タイプ
説明

args

{ enabledSources?: Set <string> | null; maxTokens?: number; metadataFilter?: Record <string, unknown> | null; query: string; sessionId?: string | null; threadId?: string | null; userId?: string | null; visibility?: string | null; }

args.enabledSources?

Set <string> | null

args.maxTokens?

number

任意の総コンテキスト構築予算。省略すると、以前の動作が保持されます。正でない値、整数以外の値、有限の値以外の値は、ランタイム削除前に発生します。検索とランキングの後、サーバーは500 トークンのフォーマット 予約を減算し、残りに収まるメモリ チャンク全体を必要に応じて選択します。 500 以下の正の値では、メモリの予算はありません。 500 を超える値では、チャンクが収まらない場合でも空のコンテキストが生成されることがあります。 metadata.token_count は形式が設定された出力のみを報告し、予約を除外します。

args.metadataFilter?

Record <:string, unknown: | null

args.query

string

args.sessionId?

string | null

args.threadId?

string | null

sessionId の非推奨エイリアス。空白以外の sessionId が選出されます。

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise { formatted_contextstringRecordstringunknownmetadata{ memory_countsRecordstringnumbertimingRecordstringnumbertoken_count<すれば: |number <:selected_memories? 、 ため、[] の:: <:, +gt:: <:,::: }:object [] |null >

close()
close(): Promise<void>;

このハンドルが基礎となるトランスポートを所有する場合は、それらを解放します。

戻り値

Promise <void>

DiscoveryProcessers()
discoverProcedures(args): Promise<Record<string, unknown>[]>;

パラメーター

Parameter
タイプ

args

{ metadataFilter?Recordstringunknownnullquery:string similarityThreshold?<:,:number tags?|::::::string [] |:::null topK?numberuserId?stringnullvisibility?|:string |null

args.metadataFilter?

Record <:string, unknown: | null

args.query

string

args.similarityThreshold?

number

args.tags?

string [] | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:Record <:string, unknown+gt:[]+gt:

getProcedure()
getProcedure(args): Promise<unknown>;

パラメーター

Parameter
タイプ

args

{ includeDeleted?: boolean; procedureName: string; userId?: string | null; visibility?: string | null; }

args.includeDeleted?

boolean

args.procedureName

string

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <unknown>

getSemantic()
getSemantic(args): Promise<unknown>;

パラメーター

Parameter
タイプ

args

{ label: string; userId?: string | null; visibility?: string | null; }

args.label

string

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <unknown>

getTaxonomicTerm()
getTaxonomicTerm(args): Promise<unknown>;

パラメーター

Parameter
タイプ

args

{ domain: string; term: string; userId?: string | null; visibility?: string | null; }

args.domain

string

args.term

string

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <unknown>

listDomains()
listDomains(args?): Promise<string[]>;

パラメーター

Parameter
タイプ

args

{ visibility?: string | null; }

args.visibility?

string | null

戻り値

Promise <:string []:

list Editions()
listEpisodes(args?): Promise<unknown[]>;

パラメーター

Parameter
タイプ

args

{ limit?: number; sessionId?: string | null; userId?: string | null; visibility?: string | null; }

args.limit?

number

args.sessionId?

string | null

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:unknown []:

RecordTurn()
recordTurn(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  session_id: string;
  turn_seq: number;
}>;

単一の対話のタームを記録します（書込み (write) を受け入れたセマンティクス）。

パラメーター

Parameter
タイプ

args

{ content?: string | null: idempotencyKey?: string| null: isError?: boolean: modelName?: string| null: role: string: sessionId?: string| null toolCallId?: string| null toolCalls?: Record <:string, unknown:[] | null: toolName?: string| null: }

args.content?

string | null

args.idempotencyKey?

string | null

args.isError?

boolean

args.modelName?

string | null

args.role

string

args.sessionId?

string | null

args.toolCallId?

string | null

args.toolCalls?

Record <:string, unknown:[] | null

args.toolName?

string | null

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringsession_idstringturn_seq<?::::::::::number >

retrieve()
retrieve(
   memoryType,
   query,
   options?
): Promise<{
  count: number;
  results: object[];
}>;

宣言されたカスタム型のメモリをセマンティック クエリで検索します。

フィルターは、宣言されたタグ キーと完全に一致する等価である。結果の順序付けはリリース間で改善される可能性があり、契約上のものではありません。呼び出しごとに 1 つの型。

パラメーター

Parameter
タイプ

memoryType

string

query

string

options?

{ tags?: `TagMap <#tagmap>`__ | null; topK?: number; }

options.tags?

`TagMap <#tagmap>`__ | null

options.topK?

number

戻り値

Promise { countnumberresults<?:::object [] }>

save()
save(
   memoryType,
   content,
   options?
): Promise<{
  has_embedding: boolean;
  id: string;
  tags: Record<string, string | number | boolean>;
  type: string;
}>;

宣言されたカスタム型のメモリを保存します。

プラットフォームは ID（org、プロジェクト、ユーザー）をスタンプし、タイプの宣言型タグスキーマを強制します。このメソッドはクライアント側のタグ構文のみを検証するため、サーバーが一致するメッセージの場合、エラーはすばやく失敗します。組み込み型（セマンティック、エポック、分類、手順型）は拒否されます。専用のメソッドを使用します。

パラメーター

Parameter
タイプ

memoryType

string

content

string

options?

{ contextualMetadata?: Record <string, unknown> | null; tags?: `TagMap <#tagmap>`__ | null; }

options.contextualMetadata?

Record <:string, unknown: | null

options.tags?

`TagMap <#tagmap>`__ | null

戻り値

Promise { has_embeddingbooleanidstringtagsRecordstring<?:::::,string |number |boolean >::type string>

Save Edition()
saveEpisode(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  title: string;
}>;

パラメーター

Parameter
タイプ

args

{ agentId?: string | null: content: string: metadata?: Record <:string、unknown: | null: participants?: string [] | null sessionId?: string| null summary?: string| null tags?: string [] | null title: string: userId?: string| null: visibility?: string: }

args.agentId?

string | null

args.content

string

args.metadata?

Record <:string, unknown: | null

args.participants?

string [] | null

args.sessionId?

string | null

args.summary?

string | null

args.tags?

string [] | null

args.title

string

args.userId?

string | null

args.visibility?

string

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringtitle<?::::::::string >

SaveProcessor()
saveProcedure(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  procedure: string;
}>;

パラメーター

Parameter
タイプ

args

{ agentId?: string | null: allowedTools?: string [] | null: compatibility?: string| null content: string: description: string: extractionSource?: string| null license?: string| null procedure: string: resources?: Record <:string, unknown: null: sourceFormat?: string| null sourcePath?: string| null steps?: Record <:string, unknown:[] | null: tags?: string [] | null: triggerConditions?: string [] | null: updateExisting?: boolean: userId?: string| null: visibility?: string: }

args.agentId?

string | null

args.allowedTools?

string [] | null

args.compatibility?

string | null

args.content

string

args.description

string

args.extractionSource?

string | null

args.license?

string | null

args.procedure

string

args.resources?

Record <:string, unknown:[] | null

args.sourceFormat?

string | null

args.sourcePath?

string | null

args.steps?

Record <:string, unknown:[] | null

args.tags?

string [] | null

args.triggerConditions?

string [] | null

args.updateExisting?

boolean

args.userId?

string | null

args.visibility?

string

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringprocedure<?::::::::string >

saveSemantic()
saveSemantic(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  label: string;
}>;

パラメーター

Parameter
タイプ

args

{ agentId?: string | null: label: string: metadata?: Record <:string、unknown: | null source?: string: text: string: upsert?: boolean: userId?: string| null visibility?: string: }

args.agentId?

string | null

args.label

string

args.metadata?

Record <:string, unknown: | null

args.source?

string

args.text

string

args.upsert?

boolean

args.userId?

string | null

args.visibility?

string

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringlabel<?::::::::string >

saveTaxonomic()
saveTaxonomic(args): Promise<{
  acknowledged: boolean;
  domain: string;
  has_embedding: boolean;
  id: string;
  term: string;
}>;

パラメーター

Parameter
タイプ

args

{ definition: string; domain: string; relatedTerms?: string [] | null; term: string; userId?: string | null; visibility?: string; }

args.definition

string

args.domain

string

args.relatedTerms?

string [] | null

args.term

string

args.userId?

string | null

args.visibility?

string

戻り値

Promise { acknowledgedbooleandomainstringhas_embeddingbooleanidstringterm<?::::::::::string >

search()
search(args): Promise<object[]>;

1 つ以上のメモリ ソースを検索し、1 つのランク付けされたリストを返します。

パラメーター

Parameter
タイプ

args

{ domain?: string | null: metadataFilter?: Record <:string、unknown: | null: query: string: sessionId?: string | null similarityThreshold?: number: sources?: string|読み取り専用 string [] | null tags?: string [] | null topK?: number: userId?: string| null: visibility?: string| null: }

args.domain?

string | null

args.metadataFilter?

Record <:string, unknown: | null

args.query

string

args.sessionId?

string | null

args.similarityThreshold?

number

args.sources?

string | 読み取り専用 string [] | null

args.tags?

string [] | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:object []:

search Editions()
searchEpisodes(args): Promise<object[]>;

パラメーター

Parameter
タイプ

args

{ query: string; sessionId?: string | null; topK?: number; userId?: string | null; visibility?: string | null; }

args.query

string

args.sessionId?

string | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:object []:

searchSemantics()
searchSemantic(args): Promise<object[]>;

パラメーター

Parameter
タイプ

args

{ query: string; topK?: number; userId?: string | null; visibility?: string | null; }

args.query

string

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:object []:

searchTaxonomic()
searchTaxonomic(args): Promise<object[]>;

パラメーター

Parameter
タイプ

args

{ domain?: string | null; query: string; topK?: number; userId?: string | null; visibility?: string | null; }

args.domain?

string | null

args.query

string

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:object []:

メモリ APIError

HTTPメモリ トランスポートからの型指定されたトランスポート エラーのベース。

拡張

  • Error

による拡張

  • `MemoryAuthError "#memoryautherror"gt:__

  • `MemoryNotProvisionedError <#memorynotprovisionederror>`__

  • `MemoryBadRequestError <#memorybadrequesterror>`__

  • `MemoryServerError <#memoryservererror>`__

  • `MemoryConnectionError "#memory connectionerror"gt,`__

Constructor

new MemoryAPIError(message, opts?): MemoryAPIError;

パラメーター

Parameter
タイプ

message

string

opts

{ code?: string | null; responseText?: string | null; status?: number | null; }

opts.code?

string | null

opts.responseText?

string | null

opts.status?

number | null

戻り値

`MemoryAPIError "#memorypierror"gt:`__

の上書き

Error.constructor

プロパティ

プロパティ
Modifier
タイプ

code

readonly

string | null

responseText

readonly

string | null

status

readonly

number | null

memoryAuthError

401 / 403 応答に対して発生します。

拡張

  • `MemoryAPIError "#memorypierror"gt:`__

Constructor

new MemoryAuthError(message, opts?): MemoryAuthError;

パラメーター

Parameter
タイプ

message

string

opts?

{ code?: string | null; responseText?: string | null; status?: number | null; }

opts.code?

string | null

opts.responseText?

string | null

opts.status?

number | null

戻り値

`MemoryAuthError "#memoryautherror"gt:__

の上書き

`MemoryAPIError <#memoryapierror>`__. `constructor <#constructor-1>`__

プロパティ

プロパティ
Modifier
タイプ
から継承

code

readonly

string | null

`MemoryAPIError "#memorypierror"gt=`__. `code <:#property-code+gt:__

responseText

readonly

string | null

`MemoryAPIError "#memorypierror"gt=`__. `responseText <:#property-Responsetext+gt:__

status

readonly

number | null

`MemoryAPIError "#memorypierror"gt=`__. `status <:#property-status+gt:__

MemoryBadRequestError

認証済みまたはプロビジョニングされていない 4x 応答に対して発生します。

拡張

  • `MemoryAPIError "#memorypierror"gt:`__

による拡張

  • `MemoryRouteNotFoundError "#memoryroutenot Founderror"=======================================================================

Constructor

new MemoryBadRequestError(message, opts?): MemoryBadRequestError;

パラメーター

Parameter
タイプ

message

string

opts?

{ code?: string | null; responseText?: string | null; status?: number | null; }

opts.code?

string | null

opts.responseText?

string | null

opts.status?

number | null

戻り値

`MemoryBadRequestError <#memorybadrequesterror>`__

の上書き

`MemoryAPIError <#memoryapierror>`__. `constructor <#constructor-1>`__

プロパティ

プロパティ
Modifier
タイプ
から継承

code

readonly

string | null

`MemoryAPIError "#memorypierror"gt=`__. `code <:#property-code+gt:__

responseText

readonly

string | null

`MemoryAPIError "#memorypierror"gt=`__. `responseText <:#property-Responsetext+gt:__

status

readonly

number | null

`MemoryAPIError "#memorypierror"gt=`__. `status <:#property-status+gt:__

memoryClientAdapter

Memory ファサード用の単一の MemoryClient ベースのランタイム + CRUDクライアント。

実装

  • `MemoryRuntime "#memoryruntime"gt,`__

  • `MemoryCrudClient "#memoryCRUDclient"gt:__

Constructor

new MemoryClientAdapter(opts): MemoryClientAdapter;

パラメーター

Parameter
タイプ

opts

`MemoryClientAdapterOptions <#memoryclientadapteroptions>`__

戻り値

`MemoryClientAdapter <#memoryclientadapter>`__

メソッド

buildContext()
buildContext(args): Promise<{
  formatted_context: string | Record<string, unknown>[];
  metadata: {
     memory_counts: Record<string, number>;
     timing: Record<string, number>;
     token_count: number;
  };
  selected_memories?: object[] | null;
}>;

パラメーター

Parameter
タイプ
説明

args

{ enabledSources?: Set <string> | null; maxTokens?: number; metadataFilter?: Record <string, unknown> | null; query: string; sessionId?: string | null; topK?: number; userId?: string | null; visibility?: string | null; }

args.enabledSources?

Set <string> | null

args.maxTokens?

number

任意の総コンテキスト構築予算。検索とランキングの後、サーバーは500 トークンのフォーマット 予約を減算し、残りに収まるメモリ チャンク全体を必要に応じて選択します。 500 以下の正の値では、メモリの予算はありません。 500 を超える値では、チャンクが収まらない場合でも空のコンテキストが生成されることがあります。

args.metadataFilter?

Record <:string, unknown: | null

args.query

string

args.sessionId?

string | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise { formatted_contextstringRecordstringunknownmetadata{ memory_countsRecordstringnumbertimingRecordstringnumbertoken_count<すれば: |number <:selected_memories? 、 ため、[] の:: <:, +gt:: <:,::: }:object [] |null >

次の実装:

`MemoryRuntime "#memoryruntime"gt,`__. `buildContext <:#Buildcontext-2+gt,`__

close()
close(): void;

任意: 基礎となるリソースをリリースします。

戻り値

void

次の実装:

`MemoryCrudClient `close<容量: ため2

createCustom()
createCustom(args): Promise<{
  has_embedding: boolean;
  id: string;
  tags: Record<string, string | number | boolean>;
  type: string;
}>;

ID はプラットフォームによってスタンプされます。

パラメーター

Parameter
タイプ

args

{ content::string contextualMetadata?RecordstringunknownnullmemoryType<:,:string tags?|::::Record <:,:string unknown|null

args.content

string

args.contextualMetadata?

Record <:string, unknown: | null

args.memoryType

string

args.tags?

Record <:string, unknown: | null

戻り値

Promise { has_embeddingbooleanidstringtagsRecordstring<?:::::,string |number |boolean >::type string>

次の実装:

`MemoryCrudClient <容量: `createCustom <:#createcustom-1+gt:__

createEpiisotric()
createEpisodic(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  title: string;
}>;

パラメーター

Parameter
タイプ

args

{ agentId?: string | null: content: string: metadata?: Record <:string、unknown: | null: participants?: string [] | null sessionId: string: summaryText?: string| null tags?: string [] | null: title: string: userId: string: visibility?: string: }

args.agentId?

string | null

args.content

string

args.metadata?

Record <:string, unknown: | null

args.participants?

string [] | null

args.sessionId

string

args.summaryText?

string | null

args.tags?

string [] | null

args.title

string

args.userId

string

args.visibility?

string

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringtitle<?::::::::string >

次の実装:

`MemoryCrudClient <#memorycrudclient>`__. `createEpisodic <#createepisodic-1>`__

createProcessal()
createProcedural(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  procedure: string;
}>;

パラメーター

Parameter
タイプ

args

{ agentId?: string | null: allowedTools?: string [] | null: compatibility?: string| null content: string: description: string: extractionSource?: string| null license?: string| null procedure: string: resources?: Record <:string, unknown: null: sourceFormat?: string| null sourcePath?: string| null steps?: Record <:string, unknown:[] | null: tags?: string [] | null: triggerConditions?: string [] | null: updateExisting?: boolean: userId: string: visibility?: string: }

args.agentId?

string | null

args.allowedTools?

string [] | null

args.compatibility?

string | null

args.content

string

args.description

string

args.extractionSource?

string | null

args.license?

string | null

args.procedure

string

args.resources?

Record <:string, unknown:[] | null

args.sourceFormat?

string | null

args.sourcePath?

string | null

args.steps?

Record <:string, unknown:[] | null

args.tags?

string [] | null

args.triggerConditions?

string [] | null

args.updateExisting?

boolean

args.userId

string

args.visibility?

string

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringprocedure<?::::::::string >

次の実装:

`MemoryCrudClient <容量: `createProcedural <:#createprocessular-1+gt:__

createSemantics()
createSemantic(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  label: string;
}>;

パラメーター

Parameter
タイプ

args

{ agentId?: string | null: label: string: metadata?: Record <:string、unknown: | null: source?: string: text: string: upsert?: boolean: userId: string: visibility?: string: }

args.agentId?

string | null

args.label

string

args.metadata?

Record <:string, unknown: | null

args.source?

string

args.text

string

args.upsert?

boolean

args.userId

string

args.visibility?

string

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringlabel<?::::::::string >

次の実装:

`MemoryCrudClient <容量:`createSemantic 1ため

createTaxonomic()
createTaxonomic(args): Promise<{
  acknowledged: boolean;
  domain: string;
  has_embedding: boolean;
  id: string;
  term: string;
}>;

パラメーター

Parameter
タイプ

args

{ definition: string; domain: string; relatedTerms?: string [] | null; term: string; userId: string; visibility?: string; }

args.definition

string

args.domain

string

args.relatedTerms?

string [] | null

args.term

string

args.userId

string

args.visibility?

string

戻り値

Promise { acknowledgedbooleandomainstringhas_embeddingbooleanidstringterm<?::::::::::string >

次の実装:

`MemoryCrudClient <容量: `createTaxonomic <:#createtaxonomic-1+gt（`__）

DiscoveryProcessers()
discoverProcedures(args): Promise<Record<string, unknown>[]>;

パラメーター

Parameter
タイプ

args

{ metadataFilter?Recordstringunknownnullquery:string similarityThreshold?<:,:number tags?|::::::string [] |:::null topK?numberuserId?stringnullvisibility?|:string |null

args.metadataFilter?

Record <:string, unknown: | null

args.query

string

args.similarityThreshold?

number

args.tags?

string [] | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:Record <:string, unknown+gt:[]+gt:

次の実装:

`MemoryRuntime "#memoryruntime"gt,`__. `discoverProcedures <:#discoverables-2+gt:`__

getDistinguishedDomains()
getDistinctDomains(args): Promise<string[]>;

パラメーター

Parameter
タイプ

args

{ visibility?: string | null; }

args.visibility?

string | null

戻り値

Promise <:string []:

次の実装:

`MemoryCrudClient <容量: `getDistinctDomains <:#getdistrictdomains-1+gt:__

getProcessal()
getProcedural(args): Promise<unknown>;

パラメーター

Parameter
タイプ

args

{ includeDeleted?: boolean; procedure?: string | null; userId?: string | null; visibility?: string | null; }

args.includeDeleted?

boolean

args.procedure?

string | null

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <unknown>

次の実装:

`MemoryCrudClient <容量: `getProcedural <:#getprocessular-1+gt,`__

getSemantic()
getSemantic(args): Promise<unknown>;

パラメーター

Parameter
タイプ

args

{ label: string; userId?: string | null; visibility?: string | null; }

args.label

string

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <unknown>

次の実装:

`MemoryCrudClient <#memorycrudclient>`__. `getSemantic <#getsemantic-2>`__

getTaxonomic()
getTaxonomic(args): Promise<unknown>;

パラメーター

Parameter
タイプ

args

{ domain: string; term?: string | null; userId?: string | null; visibility?: string | null; }

args.domain

string

args.term?

string | null

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <unknown>

次の実装:

`MemoryCrudClient <#memorycrudclient>`__. `getTaxonomic <#gettaxonomic-1>`__

listEpiisotric()
listEpisodic(args): Promise<unknown[]>;

パラメーター

Parameter
タイプ

args

{ limit?: number; sessionId?: string | null; userId?: string | null; visibility?: string | null; }

args.limit?

number

args.sessionId?

string | null

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:unknown []:

次の実装:

`MemoryCrudClient <#memorycrudclient>`__. `listEpisodic <#listepisodic-1>`__

RecordTurn()
recordTurn(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  session_id: string;
  turn_seq: number;
}>;

パラメーター

Parameter
タイプ

args

{ agentId?: string | null: content?: string| null: idempotencyKey?: string| null isError?: boolean: modelName?: string| null role: string: sessionId?: string| null toolCallId?: string | null toolCalls?: Record <:string、unknown:[] | null: toolName?: string| null: userId?: string| null: }

args.agentId?

string | null

args.content?

string | null

args.idempotencyKey?

string | null

args.isError?

boolean

args.modelName?

string | null

args.role

string

args.sessionId?

string | null

args.toolCallId?

string | null

args.toolCalls?

Record <:string, unknown:[] | null

args.toolName?

string | null

args.userId?

string | null

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringsession_idstringturn_seq<?::::::::::number >

次の実装:

`MemoryRuntime "#memoryruntime"gt,`__.`recordTurn <:#record:2

retrieveCustom()
retrieveCustom(args): Promise<{
  count: number;
  results: object[];
}>;

ID はプラットフォームによってスタンプされます。

パラメーター

Parameter
タイプ

args

{ memoryTypestringquerystringtags?::::Record <:string unknownnulltopK?、: |::number

args.memoryType

string

args.query

string

args.tags?

Record <:string, unknown: | null

args.topK?

number

戻り値

Promise { countnumberresults<?:::object [] }>

次の実装:

`MemoryCrudClient <#memorycrudclient>`__. `retrieveCustom <#retrievecustom-1>`__

search Editions()
searchEpisodes(args): Promise<object[]>;

パラメーター

Parameter
タイプ

args

{ query: string; sessionId?: string | null; topK?: number; userId?: string | null; visibility?: string | null; }

args.query

string

args.sessionId?

string | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:object []:

次の実装:

`MemoryRuntime "#memoryruntime"gt,`__. `searchEpisodes <:#searchepisodes-2+gt:__

searchSemantics()
searchSemantic(args): Promise<object[]>;

パラメーター

Parameter
タイプ

args

{ query: string; topK?: number; userId?: string | null; visibility?: string | null; }

args.query

string

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:object []:

次の実装:

`MemoryRuntime "#memoryruntime"gt,`__. `searchSemantic &セマンティック -2 <:__

searchTaxonomic()
searchTaxonomic(args): Promise<object[]>;

パラメーター

Parameter
タイプ

args

{ domain?: string | null; query: string; topK?: number; userId?: string | null; visibility?: string | null; }

args.domain?

string | null

args.query

string

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:object []:

次の実装:

`MemoryRuntime <#memoryruntime>`__. `searchTaxonomic <#searchtaxonomic-2>`__

memoryClientError

HTTPクライアントより前のクライアントまたは使用状況エラーのベース（ステータス コードまたはレスポンス本体なし）。

拡張

  • Error

による拡張

  • `MemoryNotSupportedError <#memorynotsupportederror>`__

Constructor

new MemoryClientError(message, options?): MemoryClientError;

パラメーター

Parameter
タイプ

message

string

options?

ErrorOptions

戻り値

`MemoryClientError <#memoryclienterror>`__

の上書き

Error.constructor

memoryConnectionError

トランスポートがメモリバックエンドへの到達に失敗した場合（接続/タイムアウト）に発生します。

拡張

  • `MemoryAPIError "#memorypierror"gt:`__

Constructor

new MemoryConnectionError(message, opts?): MemoryConnectionError;

パラメーター

Parameter
タイプ

message

string

opts?

{ code?: string | null; responseText?: string | null; status?: number | null; }

opts.code?

string | null

opts.responseText?

string | null

opts.status?

number | null

戻り値

`MemoryConnectionError "#memory connectionerror"gt,`__

の上書き

`MemoryAPIError <#memoryapierror>`__. `constructor <#constructor-1>`__

プロパティ

プロパティ
Modifier
タイプ
から継承

code

readonly

string | null

`MemoryAPIError "#memorypierror"gt=`__. `code <:#property-code+gt:__

responseText

readonly

string | null

`MemoryAPIError "#memorypierror"gt=`__. `responseText <:#property-Responsetext+gt:__

status

readonly

number | null

`MemoryAPIError "#memorypierror"gt=`__. `status <:#property-status+gt:__

memoryIdentityError

必須の ID ディメンションを解決できない場合に発生します。

拡張

  • Error

Constructor

new MemoryIdentityError(message): MemoryIdentityError;

パラメーター

Parameter
タイプ

message

string

戻り値

`MemoryIdentityError <#memoryidentityerror>`__

の上書き

Error.constructor

MemoryNotProvisionedError

プロジェクトのメモリ実行時間にまだ到達できない場合に発生します。

拡張

  • `MemoryAPIError "#memorypierror"gt:`__

Constructor

new MemoryNotProvisionedError(message, opts?): MemoryNotProvisionedError;

パラメーター

Parameter
タイプ

message

string

opts?

{ code?: string | null; responseText?: string | null; status?: number | null; }

opts.code?

string | null

opts.responseText?

string | null

opts.status?

number | null

戻り値

`MemoryNotProvisionedError <#memorynotprovisionederror>`__

の上書き

`MemoryAPIError <#memoryapierror>`__. `constructor <#constructor-1>`__

プロパティ

プロパティ
Modifier
タイプ
から継承

code

readonly

string | null

`MemoryAPIError "#memorypierror"gt=`__. `code <:#property-code+gt:__

responseText

readonly

string | null

`MemoryAPIError "#memorypierror"gt=`__. `responseText <:#property-Responsetext+gt:__

status

readonly

number | null

`MemoryAPIError "#memorypierror"gt=`__. `status <:#property-status+gt:__

memoryNotSupportedError

アクティブな トランスポートモードで操作が利用できない場合に発生します。

これはHTTPリクエストが試行される前に発生するクライアント側の機能チェックであるため、ステータス コードもレスポンス本体も含まれません。

拡張

  • `MemoryClientError <#memoryclienterror>`__

Constructor

new MemoryNotSupportedError(message, options?): MemoryNotSupportedError;

パラメーター

Parameter
タイプ

message

string

options?

ErrorOptions

戻り値

`MemoryNotSupportedError <#memorynotsupportederror>`__

の上書き

`MemoryClientError <#memoryclienterror>`__. `constructor <#constructor-5>`__

memoryRouteNotFoundError

コアループリクエストが404s のときに発生し、ルート形状の不一致を暗示します。

SDK は、projectId の存在からルートシェイプを選択します（設定 ========================================================================コアループ POST の 404 は、ほとんどの場合、その形状が baseUrl がポイントバックエンドと一致しないことを意味するため、不正確な 404 ではなく、方向性のあるアクション可能なヒントが含まれます。 MemoryBadRequestError が拡張されるため、既存の 4x 処理は引き続きそれをキャッチします。

拡張

  • `MemoryBadRequestError <#memorybadrequesterror>`__

Constructor

new MemoryRouteNotFoundError(message, opts?): MemoryRouteNotFoundError;

パラメーター

Parameter
タイプ

message

string

opts?

{ code?: string | null; responseText?: string | null; status?: number | null; }

opts.code?

string | null

opts.responseText?

string | null

opts.status?

number | null

戻り値

`MemoryRouteNotFoundError "#memoryroutenot Founderror"=======================================================================

の上書き

`MemoryBadRequestError <#memorybadrequesterror>`__. `constructor <#constructor-3>`__

プロパティ

プロパティ
Modifier
タイプ
から継承

code

readonly

string | null

`MemoryBadRequestError <#memorybadrequesterror>`__. `code <#property-code-2>`__

responseText

readonly

string | null

`MemoryBadRequestError "#memorybadrequesterror"gt,`__. `responseText <:#property-Responsetext-2+gt:__

status

readonly

number | null

`MemoryBadRequestError <#memorybadrequesterror>`__. `status <#property-status-2>`__

memoryServerError

5x 応答と、本体が解析できない、または予期しない形状を持つ成功した応答の場合に発生します。

拡張

  • `MemoryAPIError "#memorypierror"gt:`__

Constructor

new MemoryServerError(message, opts?): MemoryServerError;

パラメーター

Parameter
タイプ

message

string

opts?

{ code?: string | null; responseText?: string | null; status?: number | null; }

opts.code?

string | null

opts.responseText?

string | null

opts.status?

number | null

戻り値

`MemoryServerError <#memoryservererror>`__

の上書き

`MemoryAPIError <#memoryapierror>`__. `constructor <#constructor-1>`__

プロパティ

プロパティ
Modifier
タイプ
から継承

code

readonly

string | null

`MemoryAPIError "#memorypierror"gt=`__. `code <:#property-code+gt:__

responseText

readonly

string | null

`MemoryAPIError "#memorypierror"gt=`__. `responseText <:#property-Responsetext+gt:__

status

readonly

number | null

`MemoryAPIError "#memorypierror"gt=`__. `status <:#property-status+gt:__

インターフェース

AmbientIdentityRuntime

オプション機能: 呼び出しごとに環境 ID を提供できるランタイム。

プラットフォームスタック内で実行中アプリバウンド ランタイムのみが、リクエストごとのコンテキストにアクセスできます。これは別のインターフェースであるため、ランタイムを実装するためにすべてのランタイムを必要とせずに、ファサードは機能を検出できます。

メソッド

requestContext()
requestContext(): MemoryRequestContext | null;

戻り値

`MemoryRequestContext "#memoryrequestcontext",`__ | null

memoryClientAdapterOptions

プロパティ

プロパティ
タイプ
説明

apiPrefix

string

MemoryClient に渡されるメモリパス プレフィックス （例: /api/v1/memory（UE）または /api/v1/projects/<id>/memory（ゲートウェイ）

baseUrl

string

バックエンド ベースURL （Gateway または OA）。

fetchImpl?

`FetchLike <gt:#fetch目的+gt:__

挿入可能なフェッチ（主にテスト用）。

headers?

Record <:string, string:

静的認証/ID ヘッダー（例: Authorization、X-Agent-Engine-Execution-Id）

projectScoped

boolean

選択したプレフィックスがプロジェクト範囲内であるかどうか。コアループ 404（ルートシェイプの不一致）の方向ヒントをフレーズにのみ使用します。

requestExtras?

`RequestExtras <#requestextras>`__

リクエストごとのトランスポート追加（例: アプリバウンド呼び出し用の mTLS ディストリビューション）。

routeStyle

MemoryRouteStyle

バックエンドが発音するルート規則。

timeout?

number

秒単位のリクエスト タイムアウト（デフォルトでは 30）。

Memory CrudClient

CRUD は、ファサードのタイプ固有の便宜上、 に委任します。

MemoryRuntime と同様に、テナントは各実装の内部にあります。

メソッド

close()?
optional close(): void | Promise<void>;

任意: 基礎となるリソースをリリースします。

戻り値

void | Promise <void>

createCustom()
createCustom(args): Promise<{
  has_embedding: boolean;
  id: string;
  tags: Record<string, string | number | boolean>;
  type: string;
}>;

ID はプラットフォームによってスタンプされます。

パラメーター

Parameter
タイプ

args

{ content::string contextualMetadata?RecordstringunknownnullmemoryType<:,:string tags?|::::Record <:,:string unknown|null

args.content

string

args.contextualMetadata?

Record <:string, unknown: | null

args.memoryType

string

args.tags?

Record <:string, unknown: | null

戻り値

Promise { has_embeddingbooleanidstringtagsRecordstring<?:::::,string |number |boolean >::type string>

createEpiisotric()
createEpisodic(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  title: string;
}>;

パラメーター

Parameter
タイプ

args

{ agentId?: string | null: content: string: metadata?: Record <:string、unknown: | null: participants?: string [] | null sessionId: string: summaryText?: string| null tags?: string [] | null: title: string: userId: string: visibility?: string: }

args.agentId?

string | null

args.content

string

args.metadata?

Record <:string, unknown: | null

args.participants?

string [] | null

args.sessionId

string

args.summaryText?

string | null

args.tags?

string [] | null

args.title

string

args.userId

string

args.visibility?

string

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringtitle<?::::::::string >

createProcessal()
createProcedural(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  procedure: string;
}>;

パラメーター

Parameter
タイプ

args

{ agentId?: string | null: allowedTools?: string [] | null: compatibility?: string| null content: string: description: string: extractionSource?: string| null license?: string| null procedure: string: resources?: Record <:string, unknown: null: sourceFormat?: string| null sourcePath?: string| null steps?: Record <:string, unknown:[] | null: tags?: string [] | null: triggerConditions?: string [] | null: updateExisting?: boolean: userId: string: visibility?: string: }

args.agentId?

string | null

args.allowedTools?

string [] | null

args.compatibility?

string | null

args.content

string

args.description

string

args.extractionSource?

string | null

args.license?

string | null

args.procedure

string

args.resources?

Record <:string, unknown:[] | null

args.sourceFormat?

string | null

args.sourcePath?

string | null

args.steps?

Record <:string, unknown:[] | null

args.tags?

string [] | null

args.triggerConditions?

string [] | null

args.updateExisting?

boolean

args.userId

string

args.visibility?

string

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringprocedure<?::::::::string >

createSemantics()
createSemantic(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  label: string;
}>;

パラメーター

Parameter
タイプ

args

{ agentId?: string | null: label: string: metadata?: Record <:string、unknown: | null: source?: string: text: string: upsert?: boolean: userId: string: visibility?: string: }

args.agentId?

string | null

args.label

string

args.metadata?

Record <:string, unknown: | null

args.source?

string

args.text

string

args.upsert?

boolean

args.userId

string

args.visibility?

string

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringlabel<?::::::::string >

createTaxonomic()
createTaxonomic(args): Promise<{
  acknowledged: boolean;
  domain: string;
  has_embedding: boolean;
  id: string;
  term: string;
}>;

パラメーター

Parameter
タイプ

args

{ definition: string; domain: string; relatedTerms?: string [] | null; term: string; userId: string; visibility?: string; }

args.definition

string

args.domain

string

args.relatedTerms?

string [] | null

args.term

string

args.userId

string

args.visibility?

string

戻り値

Promise { acknowledgedbooleandomainstringhas_embeddingbooleanidstringterm<?::::::::::string >

getDistinguishedDomains()
getDistinctDomains(args): Promise<string[]>;

パラメーター

Parameter
タイプ

args

{ visibility?: string | null; }

args.visibility?

string | null

戻り値

Promise <:string []:

getProcessal()
getProcedural(args): Promise<unknown>;

パラメーター

Parameter
タイプ

args

{ includeDeleted?: boolean; procedure?: string | null; userId?: string | null; visibility?: string | null; }

args.includeDeleted?

boolean

args.procedure?

string | null

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <unknown>

getSemantic()
getSemantic(args): Promise<unknown>;

パラメーター

Parameter
タイプ

args

{ label: string; userId?: string | null; visibility?: string | null; }

args.label

string

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <unknown>

getTaxonomic()
getTaxonomic(args): Promise<unknown>;

パラメーター

Parameter
タイプ

args

{ domain: string; term?: string | null; userId?: string | null; visibility?: string | null; }

args.domain

string

args.term?

string | null

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <unknown>

listEpiisotric()
listEpisodic(args): Promise<unknown[]>;

パラメーター

Parameter
タイプ

args

{ limit?: number; sessionId?: string | null; userId?: string | null; visibility?: string | null; }

args.limit?

number

args.sessionId?

string | null

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:unknown []:

retrieveCustom()
retrieveCustom(args): Promise<{
  count: number;
  results: object[];
}>;

ID はプラットフォームによってスタンプされます。

パラメーター

Parameter
タイプ

args

{ memoryTypestringquerystringtags?::::Record <:string unknownnulltopK?、: |::number

args.memoryType

string

args.query

string

args.tags?

Record <:string, unknown: | null

args.topK?

number

戻り値

Promise { countnumberresults<?:::object [] }>

メモリリクエストコンテキスト

メモリ呼び出し全体で実行される不変の ID コンテキスト。

プロパティ

プロパティ
Modifier
タイプ

agentId?

readonly

string | null

sessionId?

readonly

string | null

userId?

readonly

string | null

メモリランタイム

すべてのメモリバックエンドが実装するトランスポートシーム。

ID は解決済み引数として渡されます。テナンシーは各ランタイムの内部にあります。

メソッド

buildContext()
buildContext(args): Promise<{
  formatted_context: string | Record<string, unknown>[];
  metadata: {
     memory_counts: Record<string, number>;
     timing: Record<string, number>;
     token_count: number;
  };
  selected_memories?: object[] | null;
}>;

パラメーター

Parameter
タイプ
説明

args

{ enabledSources?: Set <string> | null; maxTokens?: number; metadataFilter?: Record <string, unknown> | null; query: string; sessionId?: string | null; topK?: number; userId?: string | null; visibility?: string | null; }

args.enabledSources?

Set <string> | null

args.maxTokens?

number

任意の総コンテキスト構築予算。検索とランキングの後、サーバーは500 トークンのフォーマット 予約を減算し、残りに収まるメモリ チャンク全体を必要に応じて選択します。 500 以下の正の値では、メモリの予算はありません。 500 を超える値では、チャンクが収まらない場合でも空のコンテキストが生成されることがあります。

args.metadataFilter?

Record <:string, unknown: | null

args.query

string

args.sessionId?

string | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise { formatted_contextstringRecordstringunknownmetadata{ memory_countsRecordstringnumbertimingRecordstringnumbertoken_count<すれば: |number <:selected_memories? 、 ため、[] の:: <:, +gt:: <:,::: }:object [] |null >

close()?
optional close(): void | Promise<void>;

任意: 基礎となるリソースをリリースします。

戻り値

void | Promise <void>

DiscoveryProcessers()
discoverProcedures(args): Promise<Record<string, unknown>[]>;

パラメーター

Parameter
タイプ

args

{ metadataFilter?Recordstringunknownnullquery:string similarityThreshold?<:,:number tags?|::::::string [] |:::null topK?numberuserId?stringnullvisibility?|:string |null

args.metadataFilter?

Record <:string, unknown: | null

args.query

string

args.similarityThreshold?

number

args.tags?

string [] | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:Record <:string, unknown+gt:[]+gt:

RecordTurn()
recordTurn(args): Promise<{
  acknowledged: boolean;
  has_embedding: boolean;
  id: string;
  session_id: string;
  turn_seq: number;
}>;

パラメーター

Parameter
タイプ

args

{ agentId?: string | null: content?: string| null: idempotencyKey?: string| null isError?: boolean: modelName?: string| null role: string: sessionId?: string| null toolCallId?: string | null toolCalls?: Record <:string、unknown:[] | null: toolName?: string| null: userId?: string| null: }

args.agentId?

string | null

args.content?

string | null

args.idempotencyKey?

string | null

args.isError?

boolean

args.modelName?

string | null

args.role

string

args.sessionId?

string | null

args.toolCallId?

string | null

args.toolCalls?

Record <:string, unknown:[] | null

args.toolName?

string | null

args.userId?

string | null

戻り値

Promise { acknowledgedbooleanhas_embeddingbooleanidstringsession_idstringturn_seq<?::::::::::number >

search Editions()
searchEpisodes(args): Promise<object[]>;

パラメーター

Parameter
タイプ

args

{ query: string; sessionId?: string | null; topK?: number; userId?: string | null; visibility?: string | null; }

args.query

string

args.sessionId?

string | null

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:object []:

searchSemantics()
searchSemantic(args): Promise<object[]>;

パラメーター

Parameter
タイプ

args

{ query: string; topK?: number; userId?: string | null; visibility?: string | null; }

args.query

string

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:object []:

searchTaxonomic()
searchTaxonomic(args): Promise<object[]>;

パラメーター

Parameter
タイプ

args

{ domain?: string | null; query: string; topK?: number; userId?: string | null; visibility?: string | null; }

args.domain?

string | null

args.query

string

args.topK?

number

args.userId?

string | null

args.visibility?

string | null

戻り値

Promise <:object []:

タイプエイリアス

ContextMetadata

type ContextMetadata = z.infer<typeof ContextMetadataSchema>;

ContextResponse

type ContextResponse = z.infer<typeof ContextResponseSchema>;

CreateEpisodicResult

type CreateEpisodicResult = z.infer<typeof CreateEpisodicResultSchema>;

CreateProcessalResult

type CreateProceduralResult = z.infer<typeof CreateProceduralResultSchema>;

[CreateSemanticsResult]

type CreateSemanticResult = z.infer<typeof CreateSemanticResultSchema>;

CreateTaxonomicResult

type CreateTaxonomicResult = z.infer<typeof CreateTaxonomicResultSchema>;

CustomMemoryRetrieveResult

type CustomMemoryRetrieveResult = z.infer<typeof CustomMemoryRetrieveResultSchema>;

CustomMemorySaveResult

type CustomMemorySaveResult = z.infer<typeof CustomMemorySaveResultSchema>;

FetchLike

type FetchLike = (url, init) => Promise<Response>;

テストがスタブを挿入できるようにするための最小のフェッチ署名。

パラメーター

Parameter
タイプ

url

string

init

RequestInit

戻り値

Promise <Response>

JsonValue

type JsonValue =
  | string
  | number
  | boolean
  | null
  | JsonValue[]
  | {
[key: string]: JsonValue;
};

MemoryChunk

type MemoryChunk = z.infer<typeof MemoryChunkSchema>;

メモリオプション

type MemoryOptions =
  | {
  apiKey?: string | null;
  baseUrl?: string | null;
  fetchImpl?: FetchLike;
  projectId?: string | null;
  serviceAccountToken?: string | null;
}
  | {
  client?: MemoryCrudClient | null;
  runtime: MemoryRuntime;
};

@mongodb-js/agent- engine-sdk-memory — Atlas エージェント エンジンの統合メモリ ファジー。

Unionメンバー

Type literal
{
  apiKey?: string | null;
  baseUrl?: string | null;
  fetchImpl?: FetchLike;
  projectId?: string | null;
  serviceAccountToken?: string | null;
}
名前
タイプ
説明

apiKey?

string | null

非推奨 （または AGENTIC_MEMORY_SERVICE_ACCOUNT_TOken env var）を使用します。エイリアスとして引き続き使用できます。は Deprecation警告を発します。serviceAccountToken

baseUrl?

string | null

fetchImpl?

`FetchLike <gt:#fetch目的+gt:__

挿入可能なフェッチ（主にテスト用）。

projectId?

string | null

serviceAccountToken?

string | null

認証: POST /api/v1/oauth/token で生成されたサービスアカウントのアクセストークン。

Type literal
{
  client?: MemoryCrudClient | null;
  runtime: MemoryRuntime;
}

メモリソース

type MemorySource = typeof MemorySource[keyof typeof MemorySource];

メモリ チャンクのソース タイプ。

RequestExtras

type RequestExtras = () => RequestInit;

トランスポート実装がでレイヤーできる追加のリクエストごとのオプション（例: mTLSエージェント）。

戻り値

RequestInit

ResolvedIdentity

type ResolvedIdentity = Record<Field, string | null>;

RetrievedCustomMemory

type RetrievedCustomMemory = z.infer<typeof RetrievedCustomMemorySchema>;

SearchSource

type SearchSource = typeof SearchSource[keyof typeof SearchSource];

Memory.search がクエリできるメモリソース。

MemorySource から stm をミラーリングします（短期間の反転は検索対象ではありません）。呼び出し元は 定数またはその string 値のいずれかを渡すことができます。

TagMap

type TagMap = Record<string,
  | TagScalar
| Record<string, TagScalar>>;

タグスカラー

type TagScalar = z.infer<typeof TagScalarSchema>;

WriteTurnResult

type WriteTurnResult = z.infer<typeof WriteTurnResultSchema>;

Variables

ContextMetadataSchema

const ContextMetadataSchema: ZodObject<{
  memory_counts: ZodDefault<ZodRecord<ZodString, ZodNumber>>;
  timing: ZodDefault<ZodRecord<ZodString, ZodNumber>>;
  token_count: ZodDefault<ZodNumber>;
}, $strip>;

ContextResponseSchema

const ContextResponseSchema: ZodObject<{
  formatted_context: ZodUnion<readonly [ZodString, ZodArray<ZodRecord<ZodString, ZodUnknown>>]>;
  metadata: ZodDefault<ZodObject<{
     memory_counts: ZodDefault<ZodRecord<ZodString, ZodNumber>>;
     timing: ZodDefault<ZodRecord<ZodString, ZodNumber>>;
     token_count: ZodDefault<ZodNumber>;
  }, $strip>>;
  selected_memories: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     content: ZodString;
     embedding: ZodOptional<ZodNullable<ZodArray<ZodNumber>>>;
     id: ZodString;
     metadata: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     similarity_score: ZodOptional<ZodNullable<ZodNumber>>;
     source: ZodEnum<{
        episodic: "episodic";
        procedural: "procedural";
        semantic: "semantic";
        stm: "stm";
        taxonomic: "taxonomic";
     }>;
     timestamp: ZodCoercedDate<unknown>;
  }, $strip>>>>;
}, $strip>;

コンテキスト構築のための最終応答モデル。 formatted_context は、サーバーの形式スタイルに応じて string またはメッセージディレクティブのリストです。

CreateEpisodicResultSchema

const CreateEpisodicResultSchema: ZodObject<{
  acknowledged: ZodDefault<ZodBoolean>;
  has_embedding: ZodBoolean;
  id: ZodString;
  title: ZodString;
}, $strip>;

CreateProcessualResultSchema

const CreateProceduralResultSchema: ZodObject<{
  acknowledged: ZodDefault<ZodBoolean>;
  has_embedding: ZodBoolean;
  id: ZodString;
  procedure: ZodString;
}, $strip>;

CreateSemanticResultSchema

const CreateSemanticResultSchema: ZodObject<{
  acknowledged: ZodDefault<ZodBoolean>;
  has_embedding: ZodBoolean;
  id: ZodString;
  label: ZodString;
}, $strip>;

CreateTaxonomicResultSchema

const CreateTaxonomicResultSchema: ZodObject<{
  acknowledged: ZodDefault<ZodBoolean>;
  domain: ZodString;
  has_embedding: ZodBoolean;
  id: ZodString;
  term: ZodString;
}, $strip>;

CustomMemoryRetrieveResultSchema

const CustomMemoryRetrieveResultSchema: ZodObject<{
  count: ZodNumber;
  results: ZodArray<ZodObject<{
     agent_id: ZodOptional<ZodNullable<ZodString>>;
     content: ZodString;
     contextual_metadata: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     id: ZodString;
     tags: ZodRecord<ZodString, ZodUnion<readonly [ZodString, ZodNumber, ZodBoolean]>>;
     type: ZodString;
     user_id: ZodOptional<ZodNullable<ZodString>>;
  }, $strip>>;
}, $strip>;

CustomMemorySaveResultSchema

const CustomMemorySaveResultSchema: ZodObject<{
  has_embedding: ZodBoolean;
  id: ZodString;
  tags: ZodRecord<ZodString, ZodUnion<readonly [ZodString, ZodNumber, ZodBoolean]>>;
  type: ZodString;
}, $strip>;

MemoryChunkSchema

const MemoryChunkSchema: ZodObject<{
  content: ZodString;
  embedding: ZodOptional<ZodNullable<ZodArray<ZodNumber>>>;
  id: ZodString;
  metadata: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
  similarity_score: ZodOptional<ZodNullable<ZodNumber>>;
  source: ZodEnum<{
     episodic: "episodic";
     procedural: "procedural";
     semantic: "semantic";
     stm: "stm";
     taxonomic: "taxonomic";
  }>;
  timestamp: ZodCoercedDate<unknown>;
}, $strip>;

任意のソースからのメモリの統合表現（STM、エポック、セマンティック、...）。

timestamp は Date に強制されます。ワイヤ上の欠損値はサーバー契約違反であり、解析時にスキーマエラーとして表示されます。

similarity_score は、チャンクを生成した検索モードの増やす上にあります。 セマンティックモードのベクトル類似度、 テキストモードのテキスト関連性、 ハイブリッドモードの 統合ランク統合スコア 。同じ方法で検索されたチャンク間で比較できます。モード間では同等ではありません。または、検索された方法が異なるソース間では同等ではありません。チャンクが検索から取得されなかった場合は null。

メモリソース

const MemorySource: object;

メモリ チャンクのソース タイプ。

型宣言

名前
タイプ
デフォルト値

EPISODIC

"episodic"

"episodic"

PROCEDURAL

"procedural"

"procedural"

SEMANTIC

"semantic"

"semantic"

STM

"stm"

"stm"

TAXONOMIC

"taxonomic"

"taxonomic"

RetrievedCustomMemorySchema

const RetrievedCustomMemorySchema: ZodObject<{
  agent_id: ZodOptional<ZodNullable<ZodString>>;
  content: ZodString;
  contextual_metadata: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
  id: ZodString;
  tags: ZodRecord<ZodString, ZodUnion<readonly [ZodString, ZodNumber, ZodBoolean]>>;
  type: ZodString;
  user_id: ZodOptional<ZodNullable<ZodString>>;
}, $strip>;

SearchSource

const SearchSource: object;

Memory.search がクエリできるメモリソース。

MemorySource から stm をミラーリングします（短期間の反転は検索対象ではありません）。呼び出し元は 定数またはその string 値のいずれかを渡すことができます。

型宣言

名前
タイプ
デフォルト値

EPISODIC

"episodic"

"episodic"

PROCEDURAL

"procedural"

"procedural"

SEMANTIC

"semantic"

"semantic"

TAXONOMIC

"taxonomic"

"taxonomic"

WriteTurnResultSchema

const WriteTurnResultSchema: ZodObject<{
  acknowledged: ZodDefault<ZodBoolean>;
  has_embedding: ZodDefault<ZodBoolean>;
  id: ZodString;
  session_id: ZodString;
  turn_seq: ZodNumber;
}, $strip>;

関数

hasAmbientIdentity()

function hasAmbientIdentity(runtime): runtime is MemoryRuntime & AmbientIdentityRuntime;

AmbientIdentityRuntime 機能の重複型チェック。

パラメーター

Parameter
タイプ

runtime

`MemoryRuntime "#memoryruntime"gt,`__

戻り値

runtime is MemoryRuntime & AmbientIdentityRuntime

restrictIdentity()

function resolveIdentity(args): ResolvedIdentity;

ID フィールドを優先順位によって解決します。引数 > を呼び出しますbind ctx > を使用しますランタイム cx。

空白または空白のみの値は、すべての階層で設定されていないものとして扱われます。

2 つのオプションの保護は、それぞれ 1 つのフィールドの階層を削除します。

suppressRuntimeUserId により、userId のランタイム階層が削除されます。幅広い可視性を必要とする読み取りでは、フィルターとして環境プリンシパルを利用してはなりません。呼び出し元または バインドによって設定された userId は意図的なものであり、引き続き適用されます。

suppressInheritedSessionId は sessionId のバインド階層とランタイム階層を削除するため、明示的な呼び出し引数のみが適用されます。 sessionId は、長期検索ではなく、交流 I/O を範囲ものにします。エポック検索はそのドキュメントに完全に一致し、統合されたエポック メモリは 1 つなしで保存されるため、継承されたセッションは何も一致しません。

パラメーター

Parameter
タイプ

args

{ bindCtx?: `MemoryRequestContext <:#memoryrequestcontext{gt:__| null: callArgs: Partial <:Record <:Field, string | null| undefined >:>gt:: required?: 読み取り専用（"userId"|"agentId"|"sessionId"）[] runtimeCtx?: `MemoryRequestContext <.#memoryrequestcontext{gt:__| null suppressInheritedSessionId?: boolean: suppressRuntimeUserId?: boolean: }

args.bindCtx?

`MemoryRequestContext "#memoryrequestcontext",`__ | null

args.callArgs

Partial <:Record <:Field, string| null| undefined >以前:

args.required?

読み取り専用 ("userId" | "agentId" | "sessionId")[]

args.runtimeCtx?

`MemoryRequestContext "#memoryrequestcontext",`__ | null

args.suppressInheritedSessionId?

boolean

args.suppressRuntimeUserId?

boolean

戻り値

`ResolvedIdentity "#resolveddentity",`__

toSearchSource()

function toSearchSource(value): SearchSource;

任意の string を SearchSource に絞り込み、不明な値をスローします。

パラメーター

Parameter
タイプ

value

string

戻り値

`SearchSource "#searchsource"gt"__

戻る
Agent- engine-memory
次へ
Python SDK
このページを評価