Pesquisar

Esta página apresenta os ajudantes de escopo voltados para o desenvolvedor junto com o tipo de resultado concreto da pesquisa Oracle.

Escopos

classe oracleagentmemory.apis.scope.Scope

Bases: object

Representa um escopo para inserção de informações ou pesquisas.

• Parâmetros:
  • id_usuário str | None
  • id_agente str | None
  • thread_id str | None

user_id

ID do usuário final. NOT_SET_MARKER significa que o campo foi omitido e deve ser resolvido pelo padrão específico da operação. O None explícito é preservado e interpretado pelas regras específicas da operação. APIs de cliente de nível superior, como OracleAgentMemory.search(), podem exigir que o escopo do usuário seja explícito. Nessas APIs, None só pode ser usado para direcionar registros sem escopo.

• Tipo: str | Nenhum

id_agente

ID do Agente. NOT_SET_MARKER significa que o campo foi omitido e deve ser resolvido pelo padrão específico da operação. O None explícito é preservado e interpretado pelas regras específicas da operação.

• Tipo: str | Nenhum

thread_id

ID de Thread. NOT_SET_MARKER significa que o campo foi omitido e deve ser resolvido pelo padrão específico da operação. O None explícito é preservado e interpretado pelas regras específicas da operação.

• Tipo: str | Nenhum

classe oracleagentmemory.apis.searchscope.SearchScope

Bases: Scope

Representa o escopo de uma consulta de pesquisa e, portanto, restringe o que pode ser retornado.

• Parâmetros:
  • id_usuário str | None
  • id_agente str | None
  • thread_id str | None
  • exact_user_match bool
  • exact_agent_match bool
  • exact_thread_match bool

user_id

ID do usuário final. Quando o valor exact_user_match resolvido é True, esse ID é correspondido exatamente, incluindo None. Quando é False, a dimensão do usuário é irrestrita. NOT_SET_MARKER é substituído por um padrão específico da operação. APIs de cliente de nível superior, como OracleAgentMemory.search(), podem exigir que o escopo do usuário seja explícito. Nessas APIs, None direciona somente registros sem escopo quando o exact_user_match é resolvido como True.

• Tipo: str | Nenhum

id_agente

ID do Agente. Quando o valor exact_agent_match resolvido é True, esse ID é correspondido exatamente, incluindo None. Quando é False, a dimensão do agente é irrestrita. NOT_SET_MARKER é substituído por um valor padrão, dependendo da operação que usa o escopo.

• Tipo: str | Nenhum

thread_id

ID de Thread. Quando o valor exact_thread_match resolvido é True, esse ID é correspondido exatamente, incluindo None. Quando é False, a dimensão de thread é irrestrita. NOT_SET_MARKER é substituído por um valor padrão, dependendo da operação que usa o escopo.

• Tipo: str | Nenhum

exact_user_match

Se deve corresponder exatamente ao user_id resolvido. True corresponde exatamente, incluindo None. False deixa a dimensão do usuário sem restrições. NOT_SET_MARKER é substituído por um padrão, dependendo da operação. APIs de cliente de nível superior, como OracleAgentMemory.search(), podem exigir que isso permaneça True.

• Tipo: bool

exact_agent_match

Se deve corresponder exatamente ao agent_id resolvido. True corresponde exatamente, incluindo None. False deixa a dimensão do agente sem restrições. NOT_SET_MARKER é substituído por um padrão, dependendo da operação.

• Tipo: bool

exact_thread_match

Se deve corresponder exatamente ao thread_id resolvido. True corresponde exatamente, incluindo None. False deixa a dimensão de thread sem restrições. NOT_SET_MARKER é substituído por um padrão, dependendo da operação.

• Tipo: bool

Resultados

classe oracleagentmemory.core.OracleSearchResult

Bases: SearchResult

Resultado da pesquisa retornado por um thread Oracle.

• Parâmetros:
  • distância float – Distância do vetor de consulta (menor é melhor).
  • record Record – Um objeto de registro que contém as informações de metadados sobre a entrada persistente.
  • id str | None – Identificador opcional associado ao registro armazenado.

propriedade content

• Tipo de Retorno: str
• Descrição: Retorna o conteúdo textual principal do registro correspondente.

propriedade formatted_content

• Tipo de Retorno: str
• Descrição: Retorna a renderização padrão XML-safe usada em prompts.

propriedade id

• Tipo de Retorno: str

  Nenhum(a)

• Descrição: Retorna o identificador estável do registro correspondente, quando disponível.

propriedade metadata

• Tipo de Retorno: dict[str, Any]

  Nenhum(a)

• Descrição: Retorne metadados de registro, se disponíveis.

propriedade record

• Tipo de Retorno: Registro
• Descrição: Retorna o registro correspondente.

método render_formatted_content

Retorna uma representação estruturada e segura em XML do conteúdo do resultado.

• Parâmetros:
  • show_thread_id bool
  • show_distance bool
  • show_timestamp bool
  • show_role bool
  • show_user_id bool
  • id_agente_mostrada bool
• Tipo de retorno: str

propriedade timestamp

• Tipo de Retorno: str

  Nenhum(a)

• Descrição: Retorna o timestamp do registro, se disponível.