Class ReasoningEngine (1.50.0)

ReasoningEngine(reasoning_engine_name: str)

Rappresenta una risorsa Vertex AI Reasoning Engine.

Proprietà

create_time

L'ora di creazione della risorsa.

display_name

Nome visualizzato di questa risorsa.

encryption_spec

Opzioni delle chiavi di crittografia gestite dal cliente per questa risorsa Vertex AI.

Se questa impostazione è impostata, tutte le risorse create da questa risorsa Vertex AI verranno criptate con la chiave di crittografia fornita.

gca_resource

La rappresentazione sottostante del protocollo delle risorse.

etichette

Etichette definite dall'utente contenenti metadati su questa risorsa.

Scopri di più sulle etichette all'indirizzo https://goo.gl/xmQnxf

comune

Il nome di questa risorsa.

resource_name

Nome completo della risorsa.

update_time

Ora dell'ultimo aggiornamento di questa risorsa.

Metodi

ReasoningEngine

ReasoningEngine(reasoning_engine_name: str)

Recupera una risorsa Reasoning Engine.

Parametro
Nome Description
reasoning_engine_name str

Obbligatorio. Un nome o ID di risorsa completo come "projects/123/locations/us-central1/reasoningEngines/456" o "456" quando il progetto e la località vengono inizializzati o passati.

crea

create(
    reasoning_engine: vertexai.reasoning_engines._reasoning_engines.Queryable,
    *,
    requirements: typing.Optional[typing.Union[str, typing.Sequence[str]]] = None,
    reasoning_engine_name: typing.Optional[str] = None,
    display_name: typing.Optional[str] = None,
    description: typing.Optional[str] = None,
    gcs_dir_name: str = "reasoning_engine",
    sys_version: typing.Optional[str] = None,
    extra_packages: typing.Optional[typing.Sequence[str]] = None
) -> vertexai.reasoning_engines._reasoning_engines.ReasoningEngine

Crea un nuovo ReasoningEngine.

Il motore di ragionamento sarà un'istanza del reasoning_engine trasmesso, in esecuzione in remoto su Vertex AI.

Contenuti src_dir di esempio (ad es. ./user_src_dir):

user_src_dir/
|-- main.py
|-- requirements.txt
|-- user_code/
|   |-- utils.py
|   |-- ...
|-- ...

Per creare un motore di ragionamento:

remote_app = ReasoningEngine.create(
    local_app,
    requirements=[
        # I.e. the PyPI dependencies listed in requirements.txt
        "google-cloud-aiplatform==1.25.0",
        "langchain==0.0.242",
        ...
    ],
    extra_packages=[
        "./user_src_dir/main.py", # a single file
        "./user_src_dir/user_code", # a directory
        ...
    ],
)
Parametri
Nome Description
reasoning_engine ReasoningEngineInterface

Obbligatorio. Il motore di ragionamento da creare.

requirements Union[str, Sequence[str]]

Facoltativo. L'insieme di dipendenze PyPI necessario. Può essere il percorso di un singolo file (requirements.txt) o un elenco ordinato di stringhe corrispondenti a ogni riga del file dei requisiti.

reasoning_engine_name str

Facoltativo. Un nome o ID di risorsa completo come "projects/123/locations/us-central1/reasoningEngines/456" o "456" quando il progetto e la località vengono inizializzati o passati. Se specifichi l'ID, deve contenere da 4 a 63 caratteri. I caratteri validi sono lettere minuscole, numeri e trattini ("-") e devono iniziare con un numero o una lettera minuscola. Se non specificato, Vertex AI genererà un valore per questo ID.

display_name str

Facoltativo. Il nome definito dall'utente del motore di ragionamento. Il nome può avere fino a 128 caratteri e può comprendere qualsiasi carattere UTF-8.

description str

Facoltativo. La descrizione del Motore di ragionamento.

gcs_dir_name CreateReasoningEngineOptions

Facoltativo. La directory del bucket GCS in staging_bucket da utilizzare per la gestione temporanea degli artefatti necessari.

sys_version str

Facoltativo. La versione del sistema Python utilizzata. Attualmente supporta qualsiasi tra "3.8", "3.9", "3.10", "3.11". Se non specificato, per impostazione predefinita sono impostati gli attributi "{major}.{minor}" di sys.version_info.

extra_packages Sequence[str]

Facoltativo. L'insieme di eventuali pacchetti aggiuntivi forniti dall'utente.

Eccezioni
Tipo Description
ValueError Se sys.version non è supportato da ReasoningEngine.
ValueError Se project non è stato impostato utilizzando vertexai.init.
ValueError Se location non è stato impostato utilizzando vertexai.init.
ValueError Se staging_bucket non è stato impostato utilizzando vertexai.init.
ValueError Se staging_bucket non inizia con "gs://".
FileNotFoundError Se extra_packages include un file o una directory
tha non esiste.
Restituisce
Tipo Description
ReasoningEngine Il motore di ragionamento creato.

delete

delete(sync: bool = True) -> None

Elimina questa risorsa Vertex AI. AVVISO: l'eliminazione è definitiva.

Parametro
Nome Description
sync bool

Se eseguire questa eliminazione in modo sincrono. Se il valore è False, questo metodo verrà eseguito in Future simultanei e qualsiasi oggetto downstream verrà immediatamente restituito e sincronizzato al termine del periodo Futuro.

list

list(
    filter: typing.Optional[str] = None,
    order_by: typing.Optional[str] = None,
    project: typing.Optional[str] = None,
    location: typing.Optional[str] = None,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    parent: typing.Optional[str] = None,
) -> typing.List[google.cloud.aiplatform.base.VertexAiResourceNoun]

Elenca tutte le istanze di questa risorsa Vertex AI.

Esempio di utilizzo:

aiplatform.BatchPredictionJobs.list( filter='state="JOB_STATE_SUCCEEDED" AND display_name="my_job"', )

aiplatform.Model.list(order_by="create_time desc, display_name")

Parametri
Nome Description
filter str

Facoltativo. Un'espressione per filtrare i risultati della richiesta. Per i nomi dei campi sono supportati sia snake_case che camelCase.

order_by str

Facoltativo. Un elenco di campi separati da virgole in base a cui ordinare, ordinati in ordine crescente. Utilizza "desc" dopo il nome di un campo per l'ordine decrescente. Campi supportati: display_name, create_time, update_time

project str

Facoltativo. Progetto da cui recuperare l'elenco. Se non viene configurato, verrà utilizzato il progetto impostato in aiplatform.init.

location str

Facoltativo. Posizione da cui recuperare l'elenco. Se non viene configurato, verrà utilizzata la località impostata in aiplatform.init.

credentials auth_credentials.Credentials

Facoltativo. Credenziali personalizzate da utilizzare per recuperare l'elenco. Esegue l'override delle credenziali impostate in aiplatform.init.

parent str

Facoltativo. Il nome della risorsa padre da cui recuperare l'elenco.

operation_schemas

operation_schemas() -> typing.Sequence[typing.Dict[str, typing.Any]]

Restituisce gli schemi dell'API (Open) per Reasoning Engine.

query

query(**kwargs) -> typing.Dict[str, typing.Any]

Esegue il motore di ragionamento per gestire la query dell'utente.

Si baserà sul metodo .query(...) dell'oggetto Python trasmesso durante la creazione di Reasoning Engine.

Restituisce
Tipo Description
dict[str, Any] La risposta dall'elaborazione della query dell'utente.

to_dict

to_dict() -> typing.Dict[str, typing.Any]

Restituisce il protocollo della risorsa come dizionario.

attesa

wait()

Metodo di supporto che blocca fino al completamento di tutti i futuri.