View Source GoogleApi.AIPlatform.V1.Api.Media (google_api_ai_platform v0.24.0)

API calls for all endpoints tagged Media.

Summary

Functions

aiplatform_media_upload(connection, parent, optional_params \\ [], opts \\ [])

Upload a file into a RagCorpus.

aiplatform_media_upload_iodata(connection, parent, upload_type, metadata, data, optional_params \\ [], opts \\ [])

Upload a file into a RagCorpus.

aiplatform_media_upload_simple(connection, parent, upload_type, metadata, data, optional_params \\ [], opts \\ [])

Upload a file into a RagCorpus.

Functions

aiplatform_media_upload(connection, parent, optional_params \\ [], opts \\ [])

@spec aiplatform_media_upload(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1UploadRagFileResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Upload a file into a RagCorpus.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the RagCorpus resource into which to upload the file. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :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.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1UploadRagFileRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1UploadRagFileResponse{}} on success
  • {:error, info} on failure

aiplatform_media_upload_iodata(connection, parent, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec aiplatform_media_upload_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1UploadRagFileRequest.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1UploadRagFileResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Upload a file into a RagCorpus.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the RagCorpus resource into which to upload the file. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
  • upload_type (type: String.t) - Upload type. Must be "multipart".
  • metadata (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1UploadRagFileRequest.t) - object metadata
  • data (type: iodata) - Content to upload, as a string or iolist
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :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.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1UploadRagFileResponse{}} on success
  • {:error, info} on failure

aiplatform_media_upload_simple(connection, parent, upload_type, metadata, data, optional_params \\ [], opts \\ [])

@spec aiplatform_media_upload_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1UploadRagFileRequest.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1UploadRagFileResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Upload a file into a RagCorpus.

Parameters

  • connection (type: GoogleApi.AIPlatform.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the RagCorpus resource into which to upload the file. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
  • upload_type (type: String.t) - Upload type. Must be "multipart".
  • metadata (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1UploadRagFileRequest.t) - object metadata
  • data (type: String.t) - Path to file containing content to upload
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :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.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1UploadRagFileResponse{}} on success
  • {:error, info} on failure