Googly.DocumentAI.Projects.Locations.Processors.ProcessorVersions.Evaluations (googly_document_ai v0.1.0)

Copy Markdown View Source

Endpoints for the Projects.Locations.Processors.ProcessorVersions.Evaluations resource.

Summary

Functions

get(name, opts \\ [])

Retrieves a specific evaluation.

list(parent, opts \\ [])

Retrieves a set of evaluations for a given processor version.

Functions

get(name, opts \\ [])

@spec get(
  String.t(),
  keyword()
) ::
  {:ok, Googly.DocumentAI.Model.GoogleCloudDocumentaiV1Evaluation.t()}
  | {:error, term()}

Retrieves a specific evaluation.

Parameters

  • name (type: String.t()) - Required. The resource name of the Evaluation to get. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}/evaluations/{evaluation}
  • opts (type: keyword()) - Query and call options (:token, plus any of the below)
    • access_token (type: String.t()) - OAuth access token.
    • alt (type: String.t()) - Data format for response.
    • callback (type: String.t()) - JSONP
    • fields (type: String.t()) - Selector specifying which fields to include in a partial response.
    • key (type: String.t()) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token (type: String.t()) - OAuth 2.0 token for the current user.
    • pretty_print (type: boolean()) - Returns response with indentations and line breaks.
    • quota_user (type: String.t()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol (type: String.t()) - Upload protocol for media (e.g. "raw", "multipart").
    • upload_type (type: String.t()) - Legacy upload protocol for media (e.g. "media", "multipart").
    • xgafv (type: String.t()) - V1 error format.

Returns

  • {:ok, %Googly.DocumentAI.Model.GoogleCloudDocumentaiV1Evaluation{}} on success
  • {:error, %Googly.DocumentAI.Error{}} on failure

list(parent, opts \\ [])

@spec list(
  String.t(),
  keyword()
) ::
  {:ok,
   Googly.DocumentAI.Model.GoogleCloudDocumentaiV1ListEvaluationsResponse.t()}
  | {:error, term()}

Retrieves a set of evaluations for a given processor version.

Parameters

  • parent (type: String.t()) - Required. The resource name of the ProcessorVersion to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
  • opts (type: keyword()) - Query and call options (:token, plus any of the below)
    • access_token (type: String.t()) - OAuth access token.
    • alt (type: String.t()) - Data format for response.
    • callback (type: String.t()) - JSONP
    • fields (type: String.t()) - Selector specifying which fields to include in a partial response.
    • key (type: String.t()) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token (type: String.t()) - OAuth 2.0 token for the current user.
    • pretty_print (type: boolean()) - Returns response with indentations and line breaks.
    • quota_user (type: String.t()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • upload_protocol (type: String.t()) - Upload protocol for media (e.g. "raw", "multipart").
    • upload_type (type: String.t()) - Legacy upload protocol for media (e.g. "media", "multipart").
    • xgafv (type: String.t()) - V1 error format.
    • page_size (type: integer()) - The standard list page size. If unspecified, at most 5 evaluations are returned. The maximum value is 100. Values above 100 are coerced to 100.
    • page_token (type: String.t()) - A page token, received from a previous ListEvaluations call. Provide this to retrieve the subsequent page.

Returns

  • {:ok, %Googly.DocumentAI.Model.GoogleCloudDocumentaiV1ListEvaluationsResponse{}} on success
  • {:error, %Googly.DocumentAI.Error{}} on failure