API

Every googlecloudvision.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Files

annotate

files.annotate Annotate Files Risk: read

await corsair.googlecloudvision.api.files.annotate({});

Input

Name	Type	Required	Description
`requests`	`object[]`	Yes	—

requests full type

{
  inputConfig: {
    gcsSource?: {
      uri: string
    },
    content?: string,
    mimeType: string
  },
  features: {
    type: string,
    maxResults?: number,
    model?: string
  }[],
  imageContext?: {
  },
  pages?: number[]
}[]

Output

Name	Type	Required	Description
`responses`	`object[]`	Yes	—

responses full type

{
}[]

asyncBatchAnnotate

files.asyncBatchAnnotate Annotate Files Async Risk: write

await corsair.googlecloudvision.api.files.asyncBatchAnnotate({});

Input

Name	Type	Required	Description
`requests`	`object[]`	Yes	—

requests full type

{
  inputConfig: {
    gcsSource: {
      uri: string
    },
    mimeType: string
  },
  features: {
    type: string,
    maxResults?: number,
    model?: string
  }[],
  imageContext?: {
  },
  outputConfig: {
    gcsDestination: {
      uri: string
    },
    batchSize?: number
  }
}[]

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`metadata`	`object`	No	—
`done`	`boolean`	No	—
`error`	`object`	No	—
`response`	`object`	No	—

metadata full type

{
}

error full type

{
  code: number,
  message: string
}

response full type

{
}

Images

annotate

images.annotate Annotate Images Risk: read

await corsair.googlecloudvision.api.images.annotate({});

Input

Name	Type	Required	Description
`requests`	`object[]`	Yes	—

requests full type

{
  image: {
    content?: string,
    source?: {
      gcsImageUri?: string,
      imageUri?: string
    }
  },
  features: {
    type: string,
    maxResults?: number,
    model?: string
  }[],
  imageContext?: {
  }
}[]

Output

Name	Type	Required	Description
`responses`	`object[]`	Yes	—

responses full type

{
}[]

asyncBatchAnnotate

images.asyncBatchAnnotate Annotate Images Async Risk: write

await corsair.googlecloudvision.api.images.asyncBatchAnnotate({});

Input

Name	Type	Required	Description
`requests`	`object[]`	Yes	—
`outputConfig`	`object`	Yes	—

requests full type

{
  image: {
    source: {
      gcsImageUri: string
    }
  },
  features: {
    type: string,
    maxResults?: number,
    model?: string
  }[],
  imageContext?: {
  }
}[]

outputConfig full type

{
  gcsDestination: {
    uri: string
  },
  batchSize?: number
}

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`metadata`	`object`	No	—
`done`	`boolean`	No	—
`error`	`object`	No	—
`response`	`object`	No	—

metadata full type

{
}

error full type

{
  code: number,
  message: string
}

response full type

{
}

locationAnnotate

images.locationAnnotate Annotate Location Images Risk: read

await corsair.googlecloudvision.api.images.locationAnnotate({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`requests`	`object[]`	Yes	—

requests full type

{
  image: {
    content?: string,
    source?: {
      gcsImageUri?: string,
      imageUri?: string
    }
  },
  features: {
    type: string,
    maxResults?: number,
    model?: string
  }[],
  imageContext?: {
  }
}[]

Output

Name	Type	Required	Description
`responses`	`object[]`	Yes	—

responses full type

{
}[]

Locations

list

locations.list List Locations Risk: read

await corsair.googlecloudvision.api.locations.list({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`filter`	`string`	No	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`locations`	`object[]`	No	—
`nextPageToken`	`string`	No	—

locations full type

{
  name: string,
  locationId: string,
  displayName?: string,
  labels?: {
  }
}[]

Operations

cancel

operations.cancel Cancel Operation Risk: write

await corsair.googlecloudvision.api.operations.cancel({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output: empty object

delete

operations.delete Delete Operation Risk: write

await corsair.googlecloudvision.api.operations.delete({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output: empty object

get

operations.get Get Operation Risk: read

await corsair.googlecloudvision.api.operations.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`metadata`	`object`	No	—
`done`	`boolean`	No	—
`error`	`object`	No	—
`response`	`object`	No	—

metadata full type

{
}

error full type

{
  code: number,
  message: string
}

response full type

{
}

list

operations.list List Operations Risk: read

await corsair.googlecloudvision.api.operations.list({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`filter`	`string`	No	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`operations`	`object[]`	No	—
`nextPageToken`	`string`	No	—

operations full type

{
  name: string,
  metadata?: {
  },
  done?: boolean,
  error?: {
    code: number,
    message: string
  },
  response?: {
  }
}[]

Products

create

products.create Create Product Risk: write

await corsair.googlecloudvision.api.products.create({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`productId`	`string`	No	—
`product`	`object`	Yes	—

product full type

{
  name?: string,
  displayName: string,
  description?: string,
  productCategory: string,
  productLabels?: {
    key: string,
    value: string
  }[]
}

Output

Name	Type	Required	Description
`name`	`string`	No	—
`displayName`	`string`	Yes	—
`description`	`string`	No	—
`productCategory`	`string`	Yes	—
`productLabels`	`object[]`	No	—

productLabels full type

{
  key: string,
  value: string
}[]

delete

products.delete Delete Product Risk: write

await corsair.googlecloudvision.api.products.delete({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output: empty object

get

products.get Get Product Risk: read

await corsair.googlecloudvision.api.products.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`displayName`	`string`	Yes	—
`description`	`string`	No	—
`productCategory`	`string`	Yes	—
`productLabels`	`object[]`	No	—

productLabels full type

{
  key: string,
  value: string
}[]

list

products.list List Products Risk: read

await corsair.googlecloudvision.api.products.list({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`products`	`object[]`	No	—
`nextPageToken`	`string`	No	—

products full type

{
  name?: string,
  displayName: string,
  description?: string,
  productCategory: string,
  productLabels?: {
    key: string,
    value: string
  }[]
}[]

purge

products.purge Purge Products Risk: destructive · Irreversible

await corsair.googlecloudvision.api.products.purge({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`productSetPurgeConfig`	`object`	No	—
`deleteOrphanProducts`	`boolean`	No	—
`force`	`true`	Yes	—

productSetPurgeConfig full type

{
  productSetId: string
}

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`metadata`	`object`	No	—
`done`	`boolean`	No	—
`error`	`object`	No	—
`response`	`object`	No	—

metadata full type

{
}

error full type

{
  code: number,
  message: string
}

response full type

{
}

update

products.update Update Product Risk: write

await corsair.googlecloudvision.api.products.update({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`product`	`object`	Yes	—
`updateMask`	`string`	No	—

product full type

{
  name?: string,
  displayName: string,
  description?: string,
  productCategory: string,
  productLabels?: {
    key: string,
    value: string
  }[]
}

Output

Name	Type	Required	Description
`name`	`string`	No	—
`displayName`	`string`	Yes	—
`description`	`string`	No	—
`productCategory`	`string`	Yes	—
`productLabels`	`object[]`	No	—

productLabels full type

{
  key: string,
  value: string
}[]

Product Sets

addProduct

productSets.addProduct Add Product to Set Risk: write

await corsair.googlecloudvision.api.productSets.addProduct({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`product`	`string`	Yes	—

Output: empty object

create

productSets.create Create Product Set Risk: write

await corsair.googlecloudvision.api.productSets.create({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`productSetId`	`string`	No	—
`productSet`	`object`	Yes	—

productSet full type

{
  name?: string,
  displayName: string,
  indexTime?: string,
  indexError?: {
  }
}

Output

Name	Type	Required	Description
`name`	`string`	No	—
`displayName`	`string`	Yes	—
`indexTime`	`string`	No	—
`indexError`	`object`	No	—

indexError full type

{
}

delete

productSets.delete Delete Product Set Risk: write

await corsair.googlecloudvision.api.productSets.delete({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output: empty object

get

productSets.get Get Product Set Risk: read

await corsair.googlecloudvision.api.productSets.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`displayName`	`string`	Yes	—
`indexTime`	`string`	No	—
`indexError`	`object`	No	—

indexError full type

{
}

import

productSets.import Import Product Sets Risk: write

await corsair.googlecloudvision.api.productSets.import({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`inputConfig`	`object`	Yes	—

inputConfig full type

{
  gcsSource: {
    csvFileUri: string
  }
}

Output

Name	Type	Required	Description
`name`	`string`	Yes	—
`metadata`	`object`	No	—
`done`	`boolean`	No	—
`error`	`object`	No	—
`response`	`object`	No	—

metadata full type

{
}

error full type

{
  code: number,
  message: string
}

response full type

{
}

list

productSets.list List Product Sets Risk: read

await corsair.googlecloudvision.api.productSets.list({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`productSets`	`object[]`	No	—
`nextPageToken`	`string`	No	—

productSets full type

{
  name?: string,
  displayName: string,
  indexTime?: string,
  indexError?: {
  }
}[]

listProducts

productSets.listProducts List Products in Set Risk: read

await corsair.googlecloudvision.api.productSets.listProducts({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`products`	`object[]`	No	—
`nextPageToken`	`string`	No	—

products full type

{
}[]

removeProduct

productSets.removeProduct Remove Product from Set Risk: write

await corsair.googlecloudvision.api.productSets.removeProduct({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`product`	`string`	Yes	—

Output: empty object

update

productSets.update Update Product Set Risk: write

await corsair.googlecloudvision.api.productSets.update({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`productSet`	`object`	Yes	—
`updateMask`	`string`	No	—

productSet full type

{
  name?: string,
  displayName: string,
  indexTime?: string,
  indexError?: {
  }
}

Output

Name	Type	Required	Description
`name`	`string`	No	—
`displayName`	`string`	Yes	—
`indexTime`	`string`	No	—
`indexError`	`object`	No	—

indexError full type

{
}

Reference Images

create

referenceImages.create Create Reference Image Risk: write

await corsair.googlecloudvision.api.referenceImages.create({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`referenceImageId`	`string`	No	—
`referenceImage`	`object`	Yes	—

referenceImage full type

{
  name?: string,
  uri: string,
  boundingPolys?: {
  }[]
}

Output

Name	Type	Required	Description
`name`	`string`	No	—
`uri`	`string`	Yes	—
`boundingPolys`	`object[]`	No	—

boundingPolys full type

{
}[]

delete

referenceImages.delete Delete Reference Image Risk: write

await corsair.googlecloudvision.api.referenceImages.delete({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output: empty object

get

referenceImages.get Get Reference Image Risk: read

await corsair.googlecloudvision.api.referenceImages.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`uri`	`string`	Yes	—
`boundingPolys`	`object[]`	No	—

boundingPolys full type

{
}[]

list

referenceImages.list List Reference Images Risk: read

await corsair.googlecloudvision.api.referenceImages.list({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`referenceImages`	`object[]`	No	—
`nextPageToken`	`string`	No	—
`pageSize`	`number`	No	—

referenceImages full type

{
  name?: string,
  uri: string,
  boundingPolys?: {
  }[]
}[]

Overview

Plugins

Files

annotate

asyncBatchAnnotate

Images

annotate

asyncBatchAnnotate

locationAnnotate

Locations

list

Operations

cancel

delete

get

list

Products

create

delete

get

list

purge

update

Product Sets

addProduct

create

delete

get

import

list

listProducts

removeProduct

update

Reference Images

create

delete

get

list

​Files

​annotate

​asyncBatchAnnotate

​Images

​annotate

​asyncBatchAnnotate

​locationAnnotate

​Locations

​list

​Operations

​cancel

​delete

​get

​list

​Products

​create

​delete

​get

​list

​purge

​update

​Product Sets

​addProduct

​create

​delete

​get

​import

​list

​listProducts

​removeProduct

​update

​Reference Images

​create

​delete

​get

​list

Files

annotate

asyncBatchAnnotate

Images

annotate

asyncBatchAnnotate

locationAnnotate

Locations

list

Operations

cancel

delete

get

list

Products

create

delete

get

list

purge

update

Product Sets

addProduct

create

delete

get

import

list

listProducts

removeProduct

update

Reference Images

create

delete

get

list