Method: projects.locations.corpora.searchConfigs.list

Lists all search configurations inside a corpus.

HTTP request

GET https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/corpora/*}/searchConfigs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of search configurations. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

Query parameters

Parameters
pageSize

integer

The maximum number of search configurations to return. The service may return fewer than this value. If unspecified, a page size of 50 will be used. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous searchConfigs.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to searchConfigs.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for searchConfigs.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "searchConfigs": [
    {
      object (SearchConfig)
    }
  ],
  "nextPageToken": string
}
Fields
searchConfigs[]

object (SearchConfig)

The search configurations from the specified corpus.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.searchConfigs.list

For more information, see the IAM documentation.