• Preparing search index...
  • The search index is not available
@google/genai
  • @google/genai
  • gaos/funcs/environments-internal-start-upload
  • environmentsInternalStartUpload

Function environmentsInternalStartUpload

  • environmentsInternalStartUpload(
        client: GoogleGenAICore,
        environment: string,
        path: string,
        x_goog_upload_command: undefined | "start",
        x_goog_upload_header_content_length: number,
        x_goog_upload_header_content_type: string,
        x_goog_upload_protocol: undefined | "resumable",
        api_version?: string,
        extract?: boolean,
        overwrite?: boolean,
        options?: Omit<RequestOptions, "extra_body">,
    ): APIPromise<
        Result<
            undefined
            | StartEnvironmentFileUploadResponse,

                | UnexpectedClientError
                | InvalidRequestError
                | RequestAbortedError
                | RequestTimeoutError
                | ConnectionError
                | GoogleGenAiError,
        >,
    >

    Start an environment file upload

    Parameters

    • client: GoogleGenAICore
    • environment: string
    • path: string
    • x_goog_upload_command: undefined | "start"
    • x_goog_upload_header_content_length: number
    • x_goog_upload_header_content_type: string
    • x_goog_upload_protocol: undefined | "resumable"
    • Optionalapi_version: string
    • Optionalextract: boolean
    • Optionaloverwrite: boolean
    • Optionaloptions: Omit<RequestOptions, "extra_body">

    Returns APIPromise<
        Result<
            undefined
            | StartEnvironmentFileUploadResponse,

                | UnexpectedClientError
                | InvalidRequestError
                | RequestAbortedError
                | RequestTimeoutError
                | ConnectionError
                | GoogleGenAiError,
        >,
    >

    Remarks

    Starts a resumable upload session for a file in an environment workspace. Upload the file bytes to the URL returned in the X-Goog-Upload-URL response header, using the resumable upload protocol.

    • Defined in src/gaos/funcs/environments-internal-start-upload.ts:41

Settings

@google/genai
  • Loading...

Generated using TypeDoc