Discovery Engine API (discoveryengine:v1alpha)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.delete

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}

  Path : v1alpha/{+name}

  HTTP Method : DELETE

  Parameters :

  name

  Description : Required. The full resource name of the experiment to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$

  Required : Yes

  Location : path

  Type : string

  Parameter Order : name

  Description : Deletes an experiment provided the experiment is in an end state (e.g. created, failed, succeeded).

• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.create

  Parameter Order : parent

  Description : Creates a new AlphaEvolveExperiment.

  Parameters :

  parent

  Location : path

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$

  Description : Required. The parent resource name (Session) of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`

  Path : v1alpha/{+parent}/alphaEvolveExperiments

  HTTP Method : POST

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.resume

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}:resume

  Path : v1alpha/{+name}:resume

  HTTP Method : POST

  Parameters :

  name

  Location : path

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$

  Description : Required. Experiment to resume. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`

  Description : Resumes a workflow to process the AlphaEvolveExperiment.

  Parameter Order : name

• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.start

  Description : Starts a workflow to process the AlphaEvolveExperiment.

  Parameter Order : name

  Parameters :

  name

  Required : Yes

  Location : path

  Type : string

  Description : Required. Experiment to start. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$

  Path : v1alpha/{+name}:start

  HTTP Method : POST

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}:start

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.list

  Path : v1alpha/{+parent}/alphaEvolveExperiments

  HTTP Method : GET

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

  Parameter Order : parent

  Description : List all AlphaEvolveExperiments in a given session.

  Parameters :

  parent

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$

  Description : Required. The parent resource name (Session) of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`

  Location : path

  Type : string

  Required : Yes

  pageSize

  Description : Optional. The maximum number of experiments to return. The service may return fewer than this value.

  Location : query

  Type : integer

  Format : int32

  pageToken

  Description : Optional. A page token, received from a previous `ListAlphaEvolveExperiments` call. Provide this to retrieve the subsequent page.

  Location : query

  Type : string

• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.acquirePrograms

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

  Path : v1alpha/{+parent}:acquirePrograms

  HTTP Method : POST

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}:acquirePrograms

  Parameters :

  parent

  Required : Yes

  Location : path

  Type : string

  Description : Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveExperiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$

  Parameter Order : parent

  Description : Acquires one or more AlphaEvolveProgram from the generated queue of programs for evaluation.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.get

  Parameters :

  name

  Description : Required. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$

  Required : Yes

  Location : path

  Type : string

  Description : Get an existing Experiment.

  Parameter Order : name

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}

  Path : v1alpha/{+name}

  HTTP Method : GET

• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.submitProgramsEvaluations

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}:submitProgramsEvaluations

  Path : v1alpha/{+parent}:submitProgramsEvaluations

  HTTP Method : POST

  Parameters :

  parent

  Description : Required. The parent resource name (AlphaEvolveExperiment) of the Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$

  Required : Yes

  Location : path

  Type : string

  Parameter Order : parent

  Description : Adds an AlphaEvolveProgramEvaluation to the experiment.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.get

  Description : Gets an existing AlphaEvolveProgram.

  Parameter Order : name

  Parameters :

  name

  Description : Required. The full resource name of the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+/alphaEvolvePrograms/[^/]+$

  Required : Yes

  Location : path

  Type : string

  Path : v1alpha/{+name}

  HTTP Method : GET

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}/alphaEvolvePrograms/{alphaEvolveProgramsId}

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.list

  Description : List all AlphaEvolvePrograms in a given experiment that follow the criteria provided in the request.

  Parameter Order : parent

  Parameters :

  pageToken

  Location : query

  Type : string

  Description : Optional. A page token, received from a previous `ListAlphaEvolvePrograms` call. Provide this to retrieve the subsequent page.

  pageSize

  Location : query

  Type : integer

  Format : int32

  Description : Optional. The maximum number of programs to return. The service may return fewer than this value.

  stateFilter

  Description : Optional. Filter to apply to the programs. Examples: "state_filter = \'COMPLETED\'" "state_filter = \'INITIALIZED\' OR "state_filter = \'EVALUATING\'" If empty, the behavior defaults to listing programs in REGISTRATION_COMPLETE state or processing state is NULL.

  Enum :

  • PROGRAM_STATE_UNSPECIFIED
  • INITIALIZED
  • GENERATING
  • EVALUATING
  • COMPLETED

  Location : query

  Type : string

  Enum Descriptions :

  • Default value. This value is unused.
  • The program is initialized.
  • The program is in generation.
  • The program is pending evaluation.
  • The program is completed.

  orderBy

  Description : Optional. Sorting criterion for the programs. Comma separated list of metrics to sort by and optionally sort order, e.g. "score1 desc, score2". The criteria are applied in the order listed in the field. An implicit criterion of sorting by create_time descending is always applied as the final tie-breaker after all other specified criteria.

  Location : query

  Type : string

  parent

  Required : Yes

  Location : path

  Type : string

  Description : Required. The parent resource name (AlphaEvolveExperiment) of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$

  Path : v1alpha/{+parent}/alphaEvolvePrograms

  HTTP Method : GET

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}/alphaEvolvePrograms

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

• ▼ ▲ discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.create

  Parameters :

  parent

  Required : Yes

  Location : path

  Type : string

  Description : Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveProgram. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$

  Description : Creates a new AlphaEvolveProgram.

  Parameter Order : parent

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

  Path : v1alpha/{+parent}/alphaEvolvePrograms

  HTTP Method : POST

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}/alphaEvolvePrograms