Type Alias RetrievalResultStep

RetrievalResultStep: {
    call_id: string;
    is_error?: boolean;
    signature?: string;
    type: "retrieval_result";
}

Vertex Retrieval result step.

Type declaration

  • call_id: string

    Required. ID to match the ID from the function call block.

  • Optionalis_error?: boolean

    Whether the retrieval resulted in an error.

  • Optionalsignature?: string

    A signature hash for backend validation.

  • type: "retrieval_result"

Remarks

Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.

Settings