Class GeminiCorporaListRequest

Namespace

Uralstech.UGemini.CorporaAPI

Lists the specified type of Corpora API resource. Response type can be GeminiCorporaListResponse, GeminiCorporaDocumentListResponse or GeminiCorporaChunkListResponse.

public class GeminiCorporaListRequest : IGeminiGetRequest, IGeminiRequest

Inheritance

object

GeminiCorporaListRequest

Implements

IGeminiGetRequest

IGeminiRequest

Extension Methods

GeminiFieldMaskGenerator.GetFieldMask(object)

Remarks

Only available in the beta API.

Constructors

GeminiCorporaListRequest(bool)

Creates a new GeminiCorporaListRequest.

public GeminiCorporaListRequest(bool useBetaApi = true)

Parameters

useBetaApi bool

Should the request use the Beta API?

Remarks

Only available in the beta API.

GeminiCorporaListRequest(IGeminiCorpusResourceId, bool)

Creates a new GeminiCorporaListRequest.

public GeminiCorporaListRequest(IGeminiCorpusResourceId parentResourceId, bool useBetaApi = true)

Parameters

parentResourceId IGeminiCorpusResourceId

The resource ID for the parent resource, if any. See ParentResourceId for more info.

useBetaApi bool

Should the request use the Beta API?

Remarks

Only available in the beta API.

Fields

ApiVersion

The API version to use.

public string ApiVersion

Field Value

string

MaxResponseObjects

Maximum number of objects to return per page. If unspecified, defaults to 10. Maximum is 20 for Documents/Corpora and 100 for Chunks.

public int MaxResponseObjects

Field Value

int

PageToken

A page token from a previous GeminiCorporaListRequest call.

public string PageToken

Field Value

string

ParentResourceId

The resource ID for the parent resource, if any.

public IGeminiCorpusResourceId ParentResourceId

Field Value

IGeminiCorpusResourceId

Remarks

Example:
To list Corpora, leave it null.
To list the Documents in a Corpus, this should be a GeminiCorpusId.
To list the Chunks in a Documents, this should be a GeminiCorpusDocumentId.

Properties

AuthMethod

The preferred authentication method.

public GeminiAuthMethod AuthMethod { get; set; }

Property Value

GeminiAuthMethod

OAuthAccessToken

The OAuth access token to authenticate the request, if using OAuthAccessToken as AuthMethod.

public string OAuthAccessToken { get; set; }

Property Value

string

Methods

GetEndpointUri(GeminiRequestMetadata)

Gets the URI to the API endpoint.

public string GetEndpointUri(GeminiRequestMetadata metadata)

Parameters

metadata GeminiRequestMetadata

The metadata of the request to be carried out on the URI.

Returns

string

The URI.