Console
    Start free

    MCP Tools Reference: aiplatform.googleapis.com

    Tool: embed_content

    Converts text or multimodal input into a high-dimensional vector representation (embedding), which is essential for tasks like semantic search, clustering, and Retrieval-Augmented Generation (RAG).

    The following sample demonstrate how to use curl to invoke the embed_content MCP tool.

    Curl Request 
      
curl  
--location  
 'https://aiplatform.googleapis.com/mcp/generate' 
  
 \ 
--header  
 'content-type: application/json' 
  
 \ 
--header  
 'accept: application/json, text/event-stream' 
  
 \ 
--data  
 '{ 
 "method": "tools/call", 
 "params": { 
 "name": "embed_content", 
 "arguments": { 
 // provide these details according to the tool' 
s  
MCP  
specification  
 } 
  
 } 
,  
 "jsonrpc" 
:  
 "2.0" 
,  
 "id" 
:  
 1 
 } 
 '

    Input Schema

    Request message for PredictionService.EmbedContent .

    EmbedContentRequest

    JSON representation 
     { 
 // Union field _model 
can be only one of the following: 
 "model" 
 : 
 string 
 // End of list of possible types for union field _model 
. 
 // Union field _content 
can be only one of the following: 
 "content" 
 : 
 { 
 object (  Content 
 
) 
 } 
 // End of list of possible types for union field _content 
. 
 // Union field _title 
can be only one of the following: 
 "title" 
 : 
 string 
 // End of list of possible types for union field _title 
. 
 // Union field _task_type 
can be only one of the following: 
 "taskType" 
 : 
 enum ( EmbeddingTaskType 
) 
 // End of list of possible types for union field _task_type 
. 
 // Union field _output_dimensionality 
can be only one of the following: 
 "outputDimensionality" 
 : 
 integer 
 // End of list of possible types for union field _output_dimensionality 
. 
 // Union field _auto_truncate 
can be only one of the following: 
 "autoTruncate" 
 : 
 boolean 
 // End of list of possible types for union field _auto_truncate 
. 
 }
    Fields

    Union field _model .

    _model can be only one of the following:

    model

    string

    Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*

    Union field _content .

    _content can be only one of the following:

    content

    object ( Content )

    Required. The content to be embedded.

    Union field _title .

    _title can be only one of the following:

    title
    (deprecated)

    string

    Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.

    Union field _task_type .

    _task_type can be only one of the following:

    taskType
    (deprecated)

    enum ( EmbeddingTaskType )

    Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.

    Union field _output_dimensionality .

    _output_dimensionality can be only one of the following:

    outputDimensionality
    (deprecated)

    integer

    Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.

    Union field _auto_truncate .

    _auto_truncate can be only one of the following:

    autoTruncate
    (deprecated)

    boolean

    Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length.

    Content

    JSON representation 
     { 
 "role" 
 : 
 string 
 , 
 "parts" 
 : 
 [ 
 { 
 object (  Part 
 
) 
 } 
 ] 
 }
    Fields
    role

    string

    Optional. The producer of the content. Must be either 'user' or 'model'.

    If not set, the service will default to 'user'.
    parts[]

    object ( Part )

    Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types.

    A Content message must have at least one Part .

    Part

    JSON representation 
     { 
 "thought" 
 : 
 boolean 
 , 
 "thoughtSignature" 
 : 
 string 
 , 
 "mediaResolution" 
 : 
 { 
 object (  MediaResolution 
 
) 
 } 
 , 
 // Union field data 
can be only one of the following: 
 "text" 
 : 
 string 
 , 
 "inlineData" 
 : 
 { 
 object (  Blob 
 
) 
 } 
 , 
 "fileData" 
 : 
 { 
 object (  FileData 
 
) 
 } 
 , 
 "functionCall" 
 : 
 { 
 object (  FunctionCall 
 
) 
 } 
 , 
 "functionResponse" 
 : 
 { 
 object (  FunctionResponse 
 
) 
 } 
 , 
 "executableCode" 
 : 
 { 
 object (  ExecutableCode 
 
) 
 } 
 , 
 "codeExecutionResult" 
 : 
 { 
 object (  CodeExecutionResult 
 
) 
 } 
 // End of list of possible types for union field data 
. 
 // Union field metadata 
can be only one of the following: 
 "videoMetadata" 
 : 
 { 
 object (  VideoMetadata 
 
) 
 } 
 // End of list of possible types for union field metadata 
. 
 }
    Fields
    thought

    boolean

    Optional. Indicates whether the part represents the model's thought process or reasoning.

    thoughtSignature

    string ( bytes format)

    Optional. An opaque signature for the thought so it can be reused in subsequent requests.

    A base64-encoded string.

    mediaResolution

    object ( MediaResolution )

    per part media resolution. Media resolution for the input media.

    Union field data .

    data can be only one of the following:

    text

    string

    Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example @my-repo will be converted to and sent as **my-repo** by the IDE agent.

    inlineData

    object ( Blob )

    Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.

    fileData

    object ( FileData )

    Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.

    functionCall

    object ( FunctionCall )

    Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.

    functionResponse

    object ( FunctionResponse )

    Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.

    executableCode

    object ( ExecutableCode )

    Optional. Code generated by the model that is intended to be executed.

    codeExecutionResult

    object ( CodeExecutionResult )

    Optional. The result of executing the ExecutableCode .

    Union field metadata .

    metadata can be only one of the following:

    videoMetadata

    object ( VideoMetadata )

    Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.

    Blob

    JSON representation 
     { 
 "mimeType" 
 : 
 string 
 , 
 "data" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    mimeType

    string

    Required. The IANA standard MIME type of the source data.
    data

    string ( bytes format)

    Required. The raw bytes of the data.

    A base64-encoded string.
    displayName

    string

    Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs.

    This field is only returned in PromptMessage for prompt management. It is used in the Gemini calls only when server-side tools ( code_execution , google_search , and url_context ) are enabled.

    FileData

    JSON representation 
     { 
 "mimeType" 
 : 
 string 
 , 
 "fileUri" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    mimeType

    string

    Required. The IANA standard MIME type of the source data.
    fileUri

    string

    Required. The URI of the file in Google Cloud Storage.
    displayName

    string

    Optional. The display name of the file. Used to provide a label or filename to distinguish files.

    This field is only returned in PromptMessage for prompt management. It is used in the Gemini calls only when server side tools ( code_execution , google_search , and url_context ) are enabled.

    FunctionCall

    JSON representation 
     { 
 "id" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "args" 
 : 
 { 
 object 
 } 
 , 
 "partialArgs" 
 : 
 [ 
 { 
 object (  PartialArg 
 
) 
 } 
 ] 
 , 
 "willContinue" 
 : 
 boolean 
 }
    Fields
    id

    string

    Optional. The unique id of the function call. If populated, the client to execute the function_call and return the response with the matching id .
    name

    string

    Optional. The name of the function to call. Matches FunctionDeclaration.name .
    args

    object ( Struct format)

    Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
    partialArgs[]

    object ( PartialArg )

    Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
    willContinue

    boolean

    Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.

    Struct

    JSON representation 
     { 
 "fields" 
 : 
 { 
 string 
 : 
 value 
 , 
 ... 
 } 
 }
    Fields
    fields

    map (key: string, value: value ( Value format))

    Unordered map of dynamically typed values.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    FieldsEntry

    JSON representation 
     { 
 "key" 
 : 
 string 
 , 
 "value" 
 : 
 value 
 }
    Fields
    key

    string

    value

    value ( Value format)

    Value

    JSON representation 
     { 
 // Union field kind 
can be only one of the following: 
 "nullValue" 
 : 
 null 
 , 
 "numberValue" 
 : 
 number 
 , 
 "stringValue" 
 : 
 string 
 , 
 "boolValue" 
 : 
 boolean 
 , 
 "structValue" 
 : 
 { 
 object 
 } 
 , 
 "listValue" 
 : 
 array 
 // End of list of possible types for union field kind 
. 
 }
    Fields
    Union field kind . The kind of value. kind can be only one of the following:
    nullValue

    null

    Represents a JSON null .

    numberValue

    number

    Represents a JSON number. Must not be NaN , Infinity or -Infinity , since those are not supported in JSON. This also cannot represent large Int64 values, since JSON format generally does not support them in its number type.

    stringValue

    string

    Represents a JSON string.

    boolValue

    boolean

    Represents a JSON boolean ( true or false literal in JSON).

    structValue

    object ( Struct format)

    Represents a JSON object.

    listValue

    array ( ListValue format)

    Represents a JSON array.

    ListValue

    JSON representation 
     { 
 "values" 
 : 
 [ 
 value 
 ] 
 }
    Fields
    values[]

    value ( Value format)

    Repeated field of dynamically typed values.

    PartialArg

    JSON representation 
     { 
 "jsonPath" 
 : 
 string 
 , 
 "willContinue" 
 : 
 boolean 
 , 
 // Union field delta 
can be only one of the following: 
 "nullValue" 
 : 
 null 
 , 
 "numberValue" 
 : 
 number 
 , 
 "stringValue" 
 : 
 string 
 , 
 "boolValue" 
 : 
 boolean 
 // End of list of possible types for union field delta 
. 
 }
    Fields
    jsonPath

    string

    Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535 . e.g. "$.foo.bar[0].data".

    willContinue

    boolean

    Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.

    Union field delta . The delta of field value being streamed. delta can be only one of the following:
    nullValue

    null

    Optional. Represents a null value.

    numberValue

    number

    Optional. Represents a double value.

    stringValue

    string

    Optional. Represents a string value.

    boolValue

    boolean

    Optional. Represents a boolean value.

    FunctionResponse

    JSON representation 
     { 
 "id" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "response" 
 : 
 { 
 object 
 } 
 , 
 "parts" 
 : 
 [ 
 { 
 object (  FunctionResponsePart 
 
) 
 } 
 ] 
 }
    Fields
    id

    string

    Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call id .
    name

    string

    Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name .
    response

    object ( Struct format)

    Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
    parts[]

    object ( FunctionResponsePart )

    Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

    FunctionResponsePart

    JSON representation 
     { 
 // Union field data 
can be only one of the following: 
 "inlineData" 
 : 
 { 
 object (  FunctionResponseBlob 
 
) 
 } 
 , 
 "fileData" 
 : 
 { 
 object (  FunctionResponseFileData 
 
) 
 } 
 // End of list of possible types for union field data 
. 
 }
    Fields
    Union field data . The data of the function response part. data can be only one of the following:
    inlineData

    object ( FunctionResponseBlob )

    Inline media bytes.

    fileData

    object ( FunctionResponseFileData )

    URI based data.

    FunctionResponseBlob

    JSON representation 
     { 
 "mimeType" 
 : 
 string 
 , 
 "data" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    mimeType

    string

    Required. The IANA standard MIME type of the source data.
    data

    string ( bytes format)

    Required. Raw bytes.

    A base64-encoded string.
    displayName

    string

    Optional. Display name of the blob.

    Used to provide a label or filename to distinguish blobs.

    This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.

    FunctionResponseFileData

    JSON representation 
     { 
 "mimeType" 
 : 
 string 
 , 
 "fileUri" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 }
    Fields
    mimeType

    string

    Required. The IANA standard MIME type of the source data.
    fileUri

    string

    Required. URI.
    displayName

    string

    Optional. Display name of the file data.

    Used to provide a label or filename to distinguish file datas.

    This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.

    ExecutableCode

    JSON representation 
     { 
 "language" 
 : 
 enum ( Language 
) 
 , 
 "code" 
 : 
 string 
 }
    Fields
    language

    enum ( Language )

    Required. Programming language of the code .
    code

    string

    Required. The code to be executed.

    CodeExecutionResult

    JSON representation 
     { 
 "outcome" 
 : 
 enum ( Outcome 
) 
 , 
 "output" 
 : 
 string 
 }
    Fields
    outcome

    enum ( Outcome )

    Required. Outcome of the code execution.
    output

    string

    Optional. Contains stdout when code execution is successful, stderr or other description otherwise.

    VideoMetadata

    JSON representation 
     { 
 "startOffset" 
 : 
 string 
 , 
 "endOffset" 
 : 
 string 
 , 
 "fps" 
 : 
 number 
 }
    Fields
    startOffset

    string ( Duration format)

    Optional. The start offset of the video.

    A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .
    endOffset

    string ( Duration format)

    Optional. The end offset of the video.

    A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .
    fps

    number

    Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].

    Duration

    JSON representation 
     { 
 "seconds" 
 : 
 string 
 , 
 "nanos" 
 : 
 integer 
 }
    Fields
    seconds

    string ( int64 format)

    Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
    nanos

    integer

    Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 seconds field and a positive or negative nanos field. For durations of one second or more, a non-zero value for the nanos field must be of the same sign as the seconds field. Must be from -999,999,999 to +999,999,999 inclusive.

    MediaResolution

    JSON representation 
     { 
 // Union field value 
can be only one of the following: 
 "level" 
 : 
 enum ( Level 
) 
 // End of list of possible types for union field value 
. 
 }
    Fields

    Union field value .

    value can be only one of the following:

    level

    enum ( Level )

    The tokenization quality used for given media.

    Output Schema

    Response message for PredictionService.EmbedContent .

    EmbedContentResponse

    JSON representation 
     { 
 "embedding" 
 : 
 { 
 object (  Embedding 
 
) 
 } 
 , 
 "usageMetadata" 
 : 
 { 
 object (  UsageMetadata 
 
) 
 } 
 , 
 "truncated" 
 : 
 boolean 
 }
    Fields
    embedding

    object ( Embedding )

    The embedding generated from the input content.
    usageMetadata

    object ( UsageMetadata )

    Usage metadata about the response(s).
    truncated

    boolean

    Whether the input content was truncated before generating the embedding.

    Embedding

    JSON representation 
     { 
 "values" 
 : 
 [ 
 number 
 ] 
 }
    Fields
    values[]

    number

    Embedding vector values.

    UsageMetadata

    JSON representation 
     { 
 "promptTokenCount" 
 : 
 integer 
 , 
 "candidatesTokenCount" 
 : 
 integer 
 , 
 "totalTokenCount" 
 : 
 integer 
 , 
 "toolUsePromptTokenCount" 
 : 
 integer 
 , 
 "thoughtsTokenCount" 
 : 
 integer 
 , 
 "cachedContentTokenCount" 
 : 
 integer 
 , 
 "promptTokensDetails" 
 : 
 [ 
 { 
 object (  ModalityTokenCount 
 
) 
 } 
 ] 
 , 
 "cacheTokensDetails" 
 : 
 [ 
 { 
 object (  ModalityTokenCount 
 
) 
 } 
 ] 
 , 
 "candidatesTokensDetails" 
 : 
 [ 
 { 
 object (  ModalityTokenCount 
 
) 
 } 
 ] 
 , 
 "toolUsePromptTokensDetails" 
 : 
 [ 
 { 
 object (  ModalityTokenCount 
 
) 
 } 
 ] 
 , 
 "trafficType" 
 : 
 enum ( TrafficType 
) 
 }
    Fields
    promptTokenCount

    integer

    The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When cached_content is set, this also includes the number of tokens in the cached content.
    candidatesTokenCount

    integer

    The total number of tokens in the generated candidates.
    totalTokenCount

    integer

    The total number of tokens for the entire request. This is the sum of prompt_token_count , candidates_token_count , tool_use_prompt_token_count , and thoughts_token_count .
    toolUsePromptTokenCount

    integer

    Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
    thoughtsTokenCount

    integer

    Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
    cachedContentTokenCount

    integer

    Output only. The number of tokens in the cached content that was used for this request.
    promptTokensDetails[]

    object ( ModalityTokenCount )

    Output only. A detailed breakdown of the token count for each modality in the prompt.
    cacheTokensDetails[]

    object ( ModalityTokenCount )

    Output only. A detailed breakdown of the token count for each modality in the cached content.
    candidatesTokensDetails[]

    object ( ModalityTokenCount )

    Output only. A detailed breakdown of the token count for each modality in the generated candidates.
    toolUsePromptTokensDetails[]

    object ( ModalityTokenCount )

    Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
    trafficType

    enum ( TrafficType )

    Output only. The traffic type for this request.

    ModalityTokenCount

    JSON representation 
     { 
 "modality" 
 : 
 enum ( Modality 
) 
 , 
 "tokenCount" 
 : 
 integer 
 }
    Fields
    modality

    enum ( Modality )

    The modality that this token count applies to.
    tokenCount

    integer

    The number of tokens counted for this modality.

    Tool Annotations

    Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: