索引
AppPlatform
(接口)EventDiscoveryService
(接口)LiveVideoAnalytics
(接口)RetailService
(接口)SmartDeviceService
(接口)StreamingService
(接口)StreamsService
(接口)Warehouse
(接口)AIEnabledDevicesInputConfig
(消息)AcceleratorType
(枚举)AddApplicationStreamInputRequest
(消息)AddApplicationStreamInputResponse
(消息)AddCollectionItemRequest
(消息)AddCollectionItemResponse
(消息)AddRetailProductsToRetailProductSetResponse
(消息)Analysis
(消息)AnalysisDefinition
(消息)AnalyzeAssetMetadata
(消息)AnalyzeAssetMetadata.AnalysisStatus
(消息)AnalyzeAssetMetadata.AnalysisStatus.State
(枚举)AnalyzeAssetRequest
(消息)AnalyzeAssetResponse
(消息)AnalyzeCorpusMetadata
(消息)AnalyzeCorpusRequest
(消息)AnalyzeCorpusResponse
(消息)AnalyzerDefinition
(消息)AnalyzerDefinition.DebugOptions
(消息)AnalyzerDefinition.StreamInput
(消息)Annotation
(消息)AnnotationMatchingResult
(消息)AnnotationValue
(消息)AppPlatformCloudFunctionRequest
(消息)AppPlatformCloudFunctionRequest.StructedInputAnnotation
(消息)AppPlatformCloudFunctionResponse
(消息)AppPlatformCloudFunctionResponse.StructedOutputAnnotation
(消息)AppPlatformEventBody
(消息)AppPlatformMetadata
(消息)Application
(消息)Application.ApplicationRuntimeInfo
(消息)Application.ApplicationRuntimeInfo.GlobalOutputResource
(消息)Application.ApplicationRuntimeInfo.MonitoringConfig
(消息)Application.BillingMode
(枚举)Application.State
(枚举)ApplicationConfigs
(消息)ApplicationInstance
(消息)ApplicationNodeAnnotation
(消息)ApplicationStreamInput
(消息)Asset
(消息)AssetSource
(消息)AssetSource.AssetContentData
(消息)AssetSource.AssetGcsSource
(消息)AttributeValue
(消息)AutoscalingMetricSpec
(消息)BigQueryConfig
(消息)BoolValue
(消息)CircleArea
(消息)ClassificationPredictionResult
(消息)ClipAssetRequest
(消息)ClipAssetResponse
(消息)ClipAssetResponse.TimeIndexedUri
(消息)Collection
(消息)CollectionItem
(消息)CollectionItem.Type
(枚举)Corpus
(消息)Corpus.Type
(枚举)CreateAnalysisRequest
(消息)CreateAnnotationRequest
(消息)CreateApplicationInstancesRequest
(消息)CreateApplicationInstancesResponse
(消息)CreateApplicationRequest
(消息)CreateAssetRequest
(消息)CreateClusterRequest
(消息)CreateCollectionMetadata
(消息)CreateCollectionRequest
(消息)CreateCorpusMetadata
(消息)CreateCorpusRequest
(消息)CreateDataSchemaRequest
(消息)CreateDraftRequest
(消息)CreateEventRequest
(消息)CreateIndexEndpointMetadata
(消息)CreateIndexEndpointRequest
(消息)CreateIndexMetadata
(消息)CreateIndexRequest
(消息)CreateProcessRequest
(消息)CreateProcessorRequest
(消息)CreateSearchConfigRequest
(消息)CreateSearchHypernymRequest
(消息)Criteria
(消息)CustomProcessorSourceInfo
(消息)CustomProcessorSourceInfo.ModelSchema
(消息)CustomProcessorSourceInfo.SourceType
(枚举)DataSchema
(消息)DataSchemaDetails
(消息)DataSchemaDetails.CustomizedStructConfig
(消息)DataSchemaDetails.DataType
(枚举)DataSchemaDetails.Granularity
(枚举)DataSchemaDetails.ListConfig
(消息)DataSchemaDetails.ProtoAnyConfig
(消息)DataSchemaDetails.SearchStrategy
(消息)DataSchemaDetails.SearchStrategy.SearchStrategyType
(枚举)DataType
(枚举)DateTimeRange
(消息)DateTimeRangeArray
(消息)DedicatedResources
(消息)DeleteAnalysisRequest
(消息)DeleteAnnotationRequest
(消息)DeleteApplicationInstancesRequest
(消息)DeleteApplicationInstancesResponse
(消息)DeleteApplicationRequest
(消息)DeleteAssetMetadata
(消息)DeleteAssetRequest
(消息)DeleteCollectionMetadata
(消息)DeleteCollectionRequest
(消息)DeleteCorpusRequest
(消息)DeleteDataSchemaRequest
(消息)DeleteDraftRequest
(消息)DeleteIndexEndpointMetadata
(消息)DeleteIndexEndpointRequest
(消息)DeleteIndexMetadata
(消息)DeleteIndexRequest
(消息)DeleteProcessRequest
(消息)DeleteProcessorRequest
(消息)DeleteSearchConfigRequest
(消息)DeleteSearchHypernymRequest
(消息)DeployApplicationRequest
(消息)DeployApplicationResponse
(消息)DeployIndexMetadata
(消息)DeployIndexRequest
(消息)DeployIndexResponse
(消息)DeployRetailProductRecognitionIndexResponse
(消息)DeployedIndex
(消息)DeployedIndex.AutomaticResources
(消息)DeployedIndex.DedicatedResources
(消息)DeployedIndexReference
(消息)Draft
(消息)EventUpdateFilter
(消息)EventUpdateFilter.SpecialMode
(枚举)EventUpdateType
(枚举)ExportRetailProductRecognitionIndexCoverageResponse
(消息)FacetBucket
(消息)FacetBucket.Range
(消息)FacetBucketType
(枚举)FacetGroup
(消息)FacetProperty
(消息)FacetProperty.CustomRangeBucketSpec
(消息)FacetProperty.DateTimeBucketSpec
(消息)FacetProperty.DateTimeBucketSpec.Granularity
(枚举)FacetProperty.FixedRangeBucketSpec
(消息)FacetValue
(消息)FloatRange
(消息)FloatRangeArray
(消息)GcsSource
(消息)GeneralObjectDetectionConfig
(消息)GenerateHlsUriRequest
(消息)GenerateHlsUriResponse
(消息)GenerateRetrievalUrlRequest
(消息)GenerateRetrievalUrlResponse
(消息)GeoCoordinate
(消息)GeoLocationArray
(消息)GetAnalysisRequest
(消息)GetAnnotationRequest
(消息)GetApplicationRequest
(消息)GetAssetRequest
(消息)GetCollectionRequest
(消息)GetCorpusRequest
(消息)GetDataSchemaRequest
(消息)GetDraftRequest
(消息)GetIndexEndpointRequest
(消息)GetIndexRequest
(消息)GetInstanceRequest
(消息)GetProcessRequest
(消息)GetProcessorRequest
(消息)GetSearchConfigRequest
(消息)GetSearchHypernymRequest
(消息)GetStreamThumbnailResponse
(消息)ImageObjectDetectionPredictionResult
(消息)ImageQuery
(消息)ImageSegmentationPredictionResult
(消息)ImportAssetsMetadata
(消息)ImportAssetsRequest
(消息)ImportAssetsResponse
(消息)ImportRetailProductsResponse
(消息)Index
(消息)Index.State
(枚举)IndexAssetMetadata
(消息)IndexAssetMetadata.IndexingStatus
(消息)IndexAssetMetadata.IndexingStatus.State
(枚举)IndexAssetRequest
(消息)IndexAssetResponse
(消息)IndexEndpoint
(消息)IndexEndpoint.State
(枚举)IndexedAsset
(消息)IndexingStatus
(消息)IndexingStatus.State
(枚举)IngestAssetRequest
(消息)IngestAssetRequest.Config
(消息)IngestAssetRequest.Config.VideoType
(消息)IngestAssetRequest.Config.VideoType.ContainerFormat
(枚举)IngestAssetRequest.TimeIndexedData
(消息)IngestAssetResponse
(消息)Instance
(消息)Instance.InputResource
(消息)Instance.OutputResource
(消息)Instance.State
(枚举)IntRange
(消息)IntRangeArray
(消息)ListAnalysesRequest
(消息)ListAnalysesResponse
(消息)ListAnnotationsRequest
(消息)ListAnnotationsResponse
(消息)ListApplicationsRequest
(消息)ListApplicationsResponse
(消息)ListAssetsRequest
(消息)ListAssetsResponse
(消息)ListCollectionsRequest
(消息)ListCollectionsResponse
(消息)ListCorporaRequest
(消息)ListCorporaResponse
(消息)ListDataSchemasRequest
(消息)ListDataSchemasResponse
(消息)ListDraftsRequest
(消息)ListDraftsResponse
(消息)ListIndexEndpointsRequest
(消息)ListIndexEndpointsResponse
(消息)ListIndexesRequest
(消息)ListIndexesResponse
(消息)ListInstancesRequest
(消息)ListInstancesResponse
(消息)ListPrebuiltProcessorsRequest
(消息)ListPrebuiltProcessorsResponse
(消息)ListProcessesRequest
(消息)ListProcessesResponse
(消息)ListProcessorsRequest
(消息)ListProcessorsResponse
(消息)ListSearchConfigsRequest
(消息)ListSearchConfigsResponse
(消息)ListSearchHypernymsRequest
(消息)ListSearchHypernymsResponse
(消息)MachineSpec
(消息)MediaWarehouseConfig
(消息)ModelType
(枚举)Node
(消息)Node.InputEdge
(消息)NormalizedPolygon
(消息)NormalizedPolyline
(消息)NormalizedVertex
(消息)ObjectDetectionPredictionResult
(消息)ObjectDetectionPredictionResult.Entity
(消息)ObjectDetectionPredictionResult.IdentifiedBox
(消息)ObjectDetectionPredictionResult.IdentifiedBox.NormalizedBoundingBox
(消息)OccupancyCountConfig
(消息)OccupancyCountingPredictionResult
(消息)OccupancyCountingPredictionResult.DwellTimeInfo
(消息)OccupancyCountingPredictionResult.Entity
(消息)OccupancyCountingPredictionResult.IdentifiedBox
(消息)OccupancyCountingPredictionResult.IdentifiedBox.NormalizedBoundingBox
(消息)OccupancyCountingPredictionResult.Stats
(消息)OccupancyCountingPredictionResult.Stats.AccumulatedObjectCount
(消息)OccupancyCountingPredictionResult.Stats.ActiveZoneCount
(消息)OccupancyCountingPredictionResult.Stats.CrossingLineCount
(消息)OccupancyCountingPredictionResult.Stats.ObjectCount
(消息)OccupancyCountingPredictionResult.TrackInfo
(消息)OperationMetadata
(消息)Partition
(消息)Partition.RelativeTemporalPartition
(消息)Partition.SpatialPartition
(消息)Partition.TemporalPartition
(消息)PersonBlurConfig
(消息)PersonBlurConfig.PersonBlurType
(枚举)PersonVehicleDetectionConfig
(消息)PersonalProtectiveEquipmentDetectionConfig
(消息)PersonalProtectiveEquipmentDetectionOutput
(消息)PersonalProtectiveEquipmentDetectionOutput.DetectedPerson
(消息)PersonalProtectiveEquipmentDetectionOutput.NormalizedBoundingBox
(消息)PersonalProtectiveEquipmentDetectionOutput.PPEEntity
(消息)PersonalProtectiveEquipmentDetectionOutput.PPEIdentifiedBox
(消息)PersonalProtectiveEquipmentDetectionOutput.PersonEntity
(消息)PersonalProtectiveEquipmentDetectionOutput.PersonIdentifiedBox
(消息)Process
(消息)Processor
(消息)Processor.ProcessorState
(枚举)Processor.ProcessorType
(枚举)ProcessorConfig
(消息)ProcessorIOSpec
(消息)ProcessorIOSpec.GraphInputChannelSpec
(消息)ProcessorIOSpec.GraphOutputChannelSpec
(消息)ProcessorIOSpec.InstanceResourceInputBindingSpec
(消息)ProcessorIOSpec.InstanceResourceOutputBindingSpec
(消息)RemoveApplicationStreamInputRequest
(消息)RemoveApplicationStreamInputRequest.TargetStreamInput
(消息)RemoveApplicationStreamInputResponse
(消息)RemoveCollectionItemRequest
(消息)RemoveCollectionItemResponse
(消息)RemoveIndexAssetMetadata
(消息)RemoveIndexAssetRequest
(消息)RemoveIndexAssetResponse
(消息)RemoveRetailProductsFromRetailProductSetResponse
(消息)ResourceAnnotations
(消息)RetailBatchAnalyzeResponse
(消息)RetailEntity
(消息)RetailNormalizedBoundingBox
(消息)RetailObjectDetectionAnnotation
(消息)RetailOperationMetadata
(消息)RetailOperationMetadata.OperationMetrics
(消息)RetailPredictResults
(消息)RetailProduct
(消息)RetailProductImageSimilarity
(消息)RetailProductRecognitionAnnotation
(消息)RetailProductRecognitionResult
(消息)RetailResourceState
(枚举)RetailTagRecognitionAnnotation
(消息)RetailThirdPartyId
(消息)RunMode
(枚举)RunStatus
(消息)RunStatus.State
(枚举)SearchAssetsRequest
(消息)SearchAssetsResponse
(消息)SearchCapability
(消息)SearchCapability.Type
(枚举)SearchCapabilitySetting
(消息)SearchConfig
(消息)SearchCriteriaProperty
(消息)SearchHypernym
(消息)SearchIndexEndpointRequest
(消息)SearchIndexEndpointResponse
(消息)SearchResultItem
(消息)StreamAnnotation
(消息)StreamAnnotationType
(枚举)StreamAnnotations
(消息)StreamWithAnnotation
(消息)StreamWithAnnotation.NodeAnnotation
(消息)StringArray
(消息)UndeployApplicationRequest
(消息)UndeployApplicationResponse
(消息)UndeployIndexMetadata
(消息)UndeployIndexRequest
(消息)UndeployIndexResponse
(消息)UndeployRetailProductRecognitionIndexResponse
(消息)UpdateAnalysisRequest
(消息)UpdateAnnotationRequest
(消息)UpdateApplicationInstancesRequest
(消息)UpdateApplicationInstancesRequest.UpdateApplicationInstance
(消息)UpdateApplicationInstancesResponse
(消息)UpdateApplicationRequest
(消息)UpdateApplicationStreamInputRequest
(消息)UpdateApplicationStreamInputResponse
(消息)UpdateAssetRequest
(消息)UpdateCollectionRequest
(消息)UpdateCorpusRequest
(消息)UpdateDataSchemaRequest
(消息)UpdateDraftRequest
(消息)UpdateIndexEndpointMetadata
(消息)UpdateIndexEndpointRequest
(消息)UpdateIndexMetadata
(消息)UpdateIndexRequest
(消息)UpdateProcessRequest
(消息)UpdateProcessorRequest
(消息)UpdateSearchConfigRequest
(消息)UpdateSearchHypernymRequest
(消息)UploadAssetMetadata
(消息)UploadAssetRequest
(消息)UploadAssetResponse
(消息)UserSpecifiedAnnotation
(消息)VertexAutoMLVideoConfig
(消息)VertexAutoMLVisionConfig
(消息)VertexCustomConfig
(消息)VideoActionRecognitionPredictionResult
(消息)VideoActionRecognitionPredictionResult.IdentifiedAction
(消息)VideoClassificationPredictionResult
(消息)VideoClassificationPredictionResult.IdentifiedClassification
(消息)VideoObjectTrackingPredictionResult
(消息)VideoObjectTrackingPredictionResult.BoundingBox
(消息)VideoObjectTrackingPredictionResult.DetectedObject
(消息)VideoStreamInputConfig
(消息)ViewCollectionItemsRequest
(消息)ViewCollectionItemsResponse
(消息)ViewIndexedAssetsRequest
(消息)ViewIndexedAssetsResponse
(消息)WatchEventsRequest
(消息)WatchEventsResponse
(消息)
AppPlatform
用于描述资源处理程序的服务
AddApplicationStreamInput |
---|
将目标串流输入添加到应用。如果应用已部署,系统会创建相应的新应用实例。如果该数据流已在应用中,RPC 将失败。
|
CreateApplication |
---|
在给定的项目和位置中创建一个新应用。
|
CreateApplicationInstances |
---|
将目标串流输入添加到应用。如果应用已部署,系统会创建相应的新应用实例。如果该数据流已在应用中,RPC 将失败。
|
CreateDraft |
---|
在给定的项目和位置中创建新的草稿。
|
CreateProcessor |
---|
在给定的项目和位置中创建一个新的处理器。
|
DeleteApplication |
---|
删除单个应用。
|
DeleteApplicationInstances |
---|
移除应用的目标数据流输入,如果应用已部署,系统会删除相应的实例。如果该串流不在应用中,RPC 将失败。
|
DeleteDraft |
---|
删除单个草稿。
|
DeleteProcessor |
---|
删除单个处理器。
|
DeployApplication |
---|
部署单个应用。
|
GetApplication |
---|
获取单个应用的详细信息。
|
GetDraft |
---|
获取单个草稿的详细信息。
|
GetInstance |
---|
获取单个实例的详细信息。
|
GetProcessor |
---|
获取单个处理器的详细信息。
|
ListApplications |
---|
列出给定项目和位置中的应用。
|
ListDrafts |
---|
列出给定项目和位置中的草稿。
|
ListInstances |
---|
列出给定项目和位置中的实例。
|
ListPrebuiltProcessors |
---|
ListPrebuiltProcessors 是一个用于列出预构建处理器的自定义传递动词。
|
ListProcessors |
---|
列出给定项目和位置中的处理器。
|
RemoveApplicationStreamInput |
---|
移除应用的目标数据流输入,如果应用已部署,系统会删除相应的实例。如果该串流不在应用中,RPC 将失败。
|
UndeployApplication |
---|
取消部署单个应用。
|
UpdateApplication |
---|
更新单个应用的参数。
|
UpdateApplicationInstances |
---|
将目标串流输入添加到应用。如果应用已部署,系统会创建相应的新应用实例。如果该数据流已在应用中,RPC 将失败。
|
UpdateApplicationStreamInput |
---|
将目标数据流输入更新为应用,如果应用已部署,则系统会部署相应的实例。对于 CreateOrUpdate 行为,请将 allow_missing 设置为 true。
|
UpdateDraft |
---|
更新单个草稿的参数。
|
UpdateProcessor |
---|
更新单个处理器的参数。
|
EventDiscoveryService
以下是 Event Discovery Service 的新版本。将所有用例迁移到新的 EventDiscoveryService 后,我们将废弃 EventWatcher。这是事件发现 API,供客户发现在数据流中发生的事件更新。
WatchEvents |
---|
监控给定数据流中发生的事件更新。
|
LiveVideoAnalytics
用于描述资源处理程序的服务。借助此服务,客户端可以对流式输入运行实时视频分析 (LVA)。
CreateAnalysis |
---|
在给定的项目和位置中创建新的分析。
|
CreateProcess |
---|
在给定的项目和位置中创建一个新流程。
|
DeleteAnalysis |
---|
删除单个分析。
|
DeleteProcess |
---|
删除单个进程。
|
GetAnalysis |
---|
获取单个分析的详细信息。
|
GetProcess |
---|
获取单个进程的详细信息。
|
ListAnalyses |
---|
列出给定项目和位置中的分析。
|
ListProcesses |
---|
列出给定项目和位置中的进程。
|
UpdateAnalysis |
---|
更新单个分析的参数。
|
UpdateProcess |
---|
更新单个进程的参数。
|
RetailService
客户可以使用此服务管理 Store Vision 零售资源。
SmartDeviceService
用于描述资源处理程序的服务
StreamingService
用于接收和发送数据包的流式传输服务。
StreamsService
用于描述资源处理程序的服务。Vision API 和 Vision AI API 是由同一团队开发的两个独立 API。Vision API 供用户为图片添加注释,而 Vision AI 则是一款端到端解决方案,可供客户构建自己的计算机视觉应用。
仓库
用于管理媒体内容和元数据以进行在线播放的服务。
AddCollectionItem |
---|
将内容添加到合集中。
|
AnalyzeAsset |
---|
分析素材资源,以增强搜索功能。
|
AnalyzeCorpus |
---|
分析语料库。
|
ClipAsset |
---|
生成要下载的剪辑。该 API 会接受一个时间范围,并生成在 start_time 之后且在 end_time 之前可用的第一段内容的剪辑,该剪辑可能会超出这些边界。如果返回的剪辑的总大小超过 100MB,则会截断这些剪辑。
|
CreateAnnotation |
---|
在资源中创建注释。
|
CreateAsset |
---|
在语料库中创建资产。
|
CreateCollection |
---|
创建集合。
|
CreateCorpus |
---|
在项目中创建语料库。
|
CreateDataSchema |
---|
在语料库中创建数据架构。
|
CreateIndex |
---|
在语料库下创建索引。
|
CreateIndexEndpoint |
---|
创建 IndexEndpoint。
|
CreateSearchConfig |
---|
在语料库中创建搜索配置。 请遵循以下规则创建有效的 CreateSearchConfigRequest。--- 一般规则 --- 1. Request.search_config_id 不得与现有 SearchConfig 相关联。2. 请求必须包含至少一个非空的 search_criteria_property 或 facet_property。3. mapped_fields 不得为空,且必须映射到现有的 UGA 键。4. 所有 mapped_fields 都必须是同一类型。5. 所有 mapped_fields 都必须具有相同的粒度。6. 所有 mapped_fields 都必须使用相同的语义 SearchConfig 匹配选项。如需了解特定于媒体资源的规则,请参阅 FacetProperty 和 SearchCriteriaProperty 的注释。
|
CreateSearchHypernym |
---|
在语料库中创建 SearchHypernym。
|
DeleteAnnotation |
---|
删除资产中的注释。
|
DeleteAsset |
---|
删除语料库中的资源。
|
DeleteCollection |
---|
删除合集。
|
DeleteCorpus |
---|
仅当语料库为空时才会删除。返回空响应。
|
DeleteDataSchema |
---|
删除语料库中的数据架构。
|
DeleteIndex |
---|
删除单个索引。如需删除索引,调用方必须确保该索引未部署到任何索引端点。
|
DeleteIndexEndpoint |
---|
删除 IndexEndpoint。
|
DeleteSearchConfig |
---|
删除语料库中的搜索配置。 若要使 DeleteSearchConfigRequest 有效,Request.search_configuration.name 必须已存在。
|
DeleteSearchHypernym |
---|
删除语料库中的 SearchHypernym。
|
DeployIndex |
---|
将索引部署到 IndexEndpoint。
|
GenerateHlsUri |
---|
为 HLS 清单生成 URI。该 API 会接受一组时间范围,并为涵盖所有请求时间范围的 HLS 清单生成 URI。
|
GenerateRetrievalUrl |
---|
生成用于下载资源的签名网址。对于视频仓库,请参阅 UploadAsset 注释,了解如何允许检索其他项目中的 Cloud Storage 文件。
|
GetAnnotation |
---|
读取资产内的注解。
|
GetAsset |
---|
读取语料库中的资源。
|
GetCollection |
---|
获取集合。
|
GetCorpus |
---|
获取项目中的语料库详细信息。
|
GetDataSchema |
---|
获取语料库中的数据架构。
|
GetIndex |
---|
获取语料库下单个索引的详细信息。
|
GetIndexEndpoint |
---|
获取 IndexEndpoint。
|
GetSearchConfig |
---|
获取语料库中的搜索配置。
|
GetSearchHypernym |
---|
获取语料库中的 SearchHypernym。
|
ImportAssets |
---|
从 Cloud Storage 上的元文件导入素材资源(图片和注释)。元数据文件中的每一行都对应于一张图片(由 Cloud Storage URI 指定)及其注释。
|
IndexAsset |
---|
为搜索编入索引的资产数量为 1 个。支持的语料库类型:Corpus.Type.VIDEO_ON_DEMAND
|
IngestAsset |
---|
提取资产的数据。不允许提取根据 TTL 已过期的分块数据。此方法只能通过 gRPC API 使用(而不能通过 HTTP 使用,因为 HTTP 不支持双向流式传输)。
|
ListAnnotations |
---|
列出资源中的注释列表。
|
ListAssets |
---|
列出语料库中的资源列表。
|
ListCollections |
---|
列出语料库中的集合。
|
ListCorpora |
---|
列出项目中的所有语料库。
|
ListDataSchemas |
---|
列出语料库中的数据架构列表。
|
ListIndexEndpoints |
---|
列出项目中的所有 IndexEndpoint。
|
ListIndexes |
---|
列出给定语料库中的所有索引。
|
ListSearchConfigs |
---|
列出语料库中的所有搜索配置。
|
ListSearchHypernyms |
---|
列出语料库中的 SearchHypernym。
|
RemoveCollectionItem |
---|
从合集中移除内容。
|
RemoveIndexAsset |
---|
移除某个素材资源的搜索索引数据。支持的语料库类型:Corpus.Type.VIDEO_ON_DEMAND
|
SearchAssets |
---|
搜索媒体资产。
|
SearchIndexEndpoint |
---|
搜索已部署的索引端点(仅限图片语料库类型)。
|
UndeployIndex |
---|
从 IndexEndpoint 取消部署索引。
|
UpdateAnnotation |
---|
更新了资源中的注解。
|
UpdateAsset |
---|
更新语料库中的资源。
|
updateCollection |
---|
更新合集。
|
UpdateCorpus |
---|
更新项目中的语料库。
|
UpdateDataSchema |
---|
更新了语料库中的数据架构。
|
UpdateIndex |
---|
更新语料库下的索引。
|
UpdateIndexEndpoint |
---|
更新 IndexEndpoint。
|
UpdateSearchConfig |
---|
更新语料库中的搜索配置。 请遵循以下规则创建有效的 UpdateSearchConfigRequest。--- 一般规则 --- 1. Request.search_configuration.name 必须已存在。2. 请求必须包含至少一个非空的 search_criteria_property 或 facet_property。3. mapped_fields 不得为空,且必须映射到现有的 UGA 键。4. 所有 mapped_fields 都必须是同一类型。5. 所有 mapped_fields 都必须具有相同的粒度。6. 所有 mapped_fields 都必须使用相同的语义 SearchConfig 匹配选项。如需了解特定于媒体资源的规则,请参阅 FacetProperty 和 SearchCriteriaProperty 的注释。
|
UpdateSearchHypernym |
---|
更新语料库中的 SearchHypernym。
|
UploadAsset |
---|
通过指定资产的 Cloud Storage URI 上传资产。对于视频仓库,调用此 API 的用户需要对 Cloud Storage 文件拥有读取权限。上传后,您可以使用 GenerateRetrievalUrl API 检索该文件。默认情况下,该 API 只能检索仓库所在项目中的 Cloud Storage 文件。如需允许检索位于其他项目中的 Cloud Storage 文件,您需要找到 Vision AI 服务账号(前往 IAM,选中复选框以显示“包括 Google 提供的角色授权”,搜索“Cloud Vision AI Service Agent”),并向该服务账号授予对 Cloud Storage 文件的读取权限。
|
ViewCollectionItems |
---|
查看集合中的项。
|
ViewIndexedAssets |
---|
列出索引中的资产列表。
|
AIEnabledDevicesInputConfig
此类型没有字段。
消息,介绍了支持 AI 的设备输入配置。
AcceleratorType
表示硬件加速器类型。
枚举 | |
---|---|
ACCELERATOR_TYPE_UNSPECIFIED |
未指定的加速器类型,即无加速器。 |
NVIDIA_TESLA_K80 |
Nvidia Tesla K80 GPU。 |
NVIDIA_TESLA_P100 |
Nvidia Tesla P100 GPU。 |
NVIDIA_TESLA_V100 |
Nvidia Tesla V100 GPU。 |
NVIDIA_TESLA_P4 |
Nvidia Tesla P4 GPU。 |
NVIDIA_TESLA_T4 |
Nvidia Tesla T4 GPU。 |
NVIDIA_TESLA_A100 |
Nvidia Tesla A100 GPU。 |
TPU_V2 |
TPU v2。 |
TPU_V3 |
TPU v3。 |
AcquireLeaseRequest
用于获取租赁的请求消息。
字段 | |
---|---|
series |
系列图书的书名。 |
owner |
所有者姓名。 |
term |
租期。 |
lease_type |
租赁类型。 |
AddApplicationStreamInputRequest
用于向应用添加数据流输入的消息。
字段 | |
---|---|
name |
必需。要检索的应用的名称。格式:“projects/{project}/locations/{location}/applications/{application}” |
application_stream_inputs[] |
要添加的数据流输入,数据流资源名称是每个 StreamInput 的键,并且在每个应用中都必须是唯一的。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
AddApplicationStreamInputResponse
此类型没有字段。
AddApplicationStreamInput 响应消息。
AddCollectionItemRequest
AddCollectionItem 的请求消息。
字段 | |
---|---|
item |
必需。要添加的内容。 |
AddCollectionItemResponse
AddCollectionItem 的响应消息。
字段 | |
---|---|
item |
已添加的项目。 |
AddRetailProductsToRetailProductSetResponse
此类型没有字段。
操作完成后的 AddRetailProductsToRetailProductSet 响应。
分析
用于描述“Analysis”对象的消息。
字段 | |
---|---|
name |
资源的名称。 |
create_time |
仅限输出。创建时间戳。 |
update_time |
仅限输出。更新时间戳。 |
labels |
标签以键值对的形式提供。 |
analysis_definition |
分析的定义。 |
input_streams_mapping |
将定义中的输入参数映射到实际数据流。例如,假设您有一个名为“input-0”的流源操作符,并且您尝试从真实流“stream-0”接收数据。您可以添加以下映射:[input-0: stream-0]。 |
output_streams_mapping |
将定义中的输出参数映射到实际数据流。例如,假设您有一个名为“output-0”的流接收器运算符,并尝试发送到实际流“stream-0”。您可以添加以下映射:[output-0: stream-0]。 |
disable_event_watch |
布尔标志,用于指示您是否要停用在输入流中发生新事件时自动启动进程的功能。如果您想手动启动流程,则需要将此字段设为 true。 |
AnalysisDefinition
定义完整的分析。
下面介绍了整个实时分析流水线。您可以将其视为多图的边列表表示法。
此数据可以由人直接以 protobuf 文本格式编写,也可以由编程 API(可能是 Python 或 JavaScript,具体取决于上下文)生成。
字段 | |
---|---|
analyzers[] |
分析器定义。 |
AnalyzeAssetMetadata
AnalyzeAsset 的元数据。
字段 | |
---|---|
analysis_status[] |
所有搜索功能的分析状态。 |
start_time |
操作的开始时间。 |
update_time |
操作的更新时间。 |
AnalysisStatus
对每项搜索功能的分析状态。
字段 | |
---|---|
state |
|
status_message |
|
search_capability |
请求的搜索功能。 |
州
搜索功能的状态。
枚举 | |
---|---|
STATE_UNSPECIFIED |
默认进程状态绝不应发生。 |
IN_PROGRESS |
此功能正在开发中。 |
SUCCEEDED |
该流程已成功完成。 |
FAILED |
该流程失败。 |
AnalyzeAssetRequest
AnalyzeAsset 的请求消息。
字段 | |
---|---|
name |
必需。要分析的素材资源的资源名称。格式: |
AnalyzeAssetResponse
此类型没有字段。
AnalyzeAsset 的响应消息。
AnalyzeCorpusMetadata
AnalyzeCorpus LRO 的元数据消息。
字段 | |
---|---|
metadata |
操作的元数据。 |
AnalyzeCorpusRequest
AnalyzeCorpus 的请求消息。
字段 | |
---|---|
name |
必需。要分析资源的父语料库资源。格式: |
AnalyzeCorpusResponse
此类型没有字段。
AnalyzeCorpus LRO 的响应消息。
AnalyzerDefinition
定义分析器。
分析器使用其所代表的运算符中定义的逻辑处理其输入数据流中的数据。当然,它会为运算符中声明的输出流生成数据。
字段 | |
---|---|
analyzer |
此分析器的名称。 暂定为 [a-z][a-z0-9]*(_[a-z0-9]+)*。 |
operator |
此分析器运行的运算符的名称。 必须与受支持的运营商的名称匹配。 |
inputs[] |
输入流。 |
attrs |
此分析器应用于运算符的属性值。 提供属性名称与您要应用的实际值之间的映射。如果省略属性名称,则系统会采用预配置的默认值。 |
debug_options |
调试选项。 |
operator_option |
运营商选项。 |
DebugOptions
这些选项仅用于调试目的。
字段 | |
---|---|
environment_variables |
环境变量。 |
OperatorOption
与运营商相关的选项。
字段 | |
---|---|
tag |
运营商的标记。 |
registry |
运营商的注册表,例如 public、dev。 |
StreamInput
此分析器的输入。
我们接受以下格式的输入名称引用:
示例:
假设您有一个名为“SomeOp”的运算符,它有 2 个输出参数,第一个参数名为“foo”,第二个参数名为“bar”,还有一个名为“MyOp”的运算符,它接受 2 个输入。
此外,假设有一个名为“some-analyzer”的分析器正在运行“SomeOp”,另一个名为“my-analyzer”的分析器正在运行“MyOp”。
如需指明“my-analyzer”将使用“some-analyzer”的“foo”输出作为其第一个输入,并将“some-analyzer”的“bar”输出作为其第二个输入,您可以将此字段设置为以下内容:input = ["some-analyzer:foo", "some-analyzer:bar"]
字段 | |
---|---|
input |
数据流输入的名称(如上所述)。 |
注解
注释是素材资源中的资源。它表示素材资源中内容的键值对映射。
字段 | |
---|---|
name |
注释的资源名称。格式: |
user_specified_annotation |
用户提供的注释。 |
AnnotationCustomizedStruct
注解中的自定义结构体表示法。
字段 | |
---|---|
elements |
从元素键到元素注解值的映射。 |
AnnotationList
注释中的列表表示法。
字段 | |
---|---|
values[] |
|
AnnotationMatchingResult
存储每个搜索结果项的条件-注释匹配结果。
字段 | |
---|---|
criteria |
用于匹配的条件。它可以是输入的搜索条件,也可以是从选定的多个维度转换而来的条件。 |
matched_annotations[] |
与条件匹配的注释。 |
status |
匹配结果的状态。可能的值:FAILED_PRECONDITION - 条件不符合匹配条件。已完成匹配。 |
AnnotationValue
注解的值,包括数据架构中提供的所有类型。
字段 | |
---|---|
联合字段
|
|
int_value |
int 类型注解的值。 |
float_value |
浮点类型注解的值。 |
str_value |
字符串类型注解的值。 |
datetime_value |
日期时间类型注解的值。 |
geo_coordinate |
地理坐标类型注释的值。 |
proto_any_value |
任何 proto 值的值。 |
bool_value |
布尔类型注解的值。 |
list_value |
列表类型注解的值。 |
customized_struct_value |
自定义结构体类型注解的值。 |
AppPlatformCloudFunctionRequest
对于任何基于 Cloud Functions 的客户处理逻辑,客户的 Cloud Functions 函数都应接收 AppPlatformCloudFunctionRequest 作为请求,并将 AppPlatformCloudFunctionResponse 作为响应发回。AppPlatform 向 Cloud Functions 发送的请求消息。
字段 | |
---|---|
app_platform_metadata |
AppPlatform 的元数据,供客户识别载荷的来源。 |
annotations[] |
要由自定义 Cloud Functions 函数处理的实际注释。 |
StructedInputAnnotation
一种通用注释消息,使用结构体格式表示不同的具体注释 protobuf。
字段 | |
---|---|
ingestion_time_micros |
当前注释的提取时间。 |
annotation |
实际注解的结构体格式。 |
AppPlatformCloudFunctionResponse
客户 Cloud Functions 函数向 AppPlatform 发送的响应消息。
字段 | |
---|---|
annotations[] |
返回给 AppPlatform 的修改后的注释。如果注释字段为空,AppPlatform 会舍弃这些注释。 |
annotation_passthrough |
如果设为 true,AppPlatform 将使用原始注释,而不是丢弃它们,即使在提交的注释中为空也是如此。 |
events[] |
返回给 AppPlatform 的事件通知。通常,系统会将其配置为使用/转发给处理事件的运算符,例如 Pub/Sub 运算符。 |
StructedOutputAnnotation
一种通用注释消息,使用结构体格式表示不同的具体注释 protobuf。
字段 | |
---|---|
annotation |
实际注解的结构体格式。 |
AppPlatformEventBody
appPlatform 事件的内容消息
字段 | |
---|---|
event_message |
事件的可读取字符串,例如“场景中有 6 人以上”或“搁架是空的!”。 |
payload |
对于 Pub/Sub,它将存储在消息属性中。pubsub.proto |
event_id |
用户定义的事件 ID,用于对事件进行分类。在一个传送时间范围内,来自同一应用实例且具有相同 ID 的事件将被删除重复项,并且系统只会发送第一个事件。空 event_id 将被视为“”。 |
AppPlatformMetadata
有关 App Platform 基本元数据的消息。此消息通常附加到某个处理器输出注释,以便客户识别数据的来源。
字段 | |
---|---|
application |
应用资源名称。 |
instance_id |
实例资源 ID。实例是集合“instances”下的应用嵌套资源。 |
node |
应用图的节点名称。 |
processor |
应用节点的引用处理器资源名称。 |
应用
用于描述 Application 对象的消息
字段 | |
---|---|
name |
资源名称 |
create_time |
仅限输出。[仅限输出] 创建时间戳 |
update_time |
仅限输出。[仅限输出] 更新时间戳 |
labels |
标签作为键值对 |
display_name |
必需。解决方案的易记显示名称。 |
description |
此应用的说明。 |
application_configs |
应用图配置。 |
runtime_info |
仅限输出。应用图运行时信息。仅当应用状态等于 DEPLOYED 时才存在。 |
state |
仅限输出。应用的状态。 |
billing_mode |
应用的结算模式。 |
ApplicationRuntimeInfo
用于存储应用运行时信息的消息。
字段 | |
---|---|
deploy_time |
引擎部署时的时间戳 |
global_output_resources[] |
在全球范围内创建的资源,例如数据仓库数据架构。 |
monitoring_config |
此应用的监控相关配置。 |
GlobalOutputResource
有关应用输出资源的消息。
字段 | |
---|---|
output_resource |
输出资源的完整资源名称。 |
producer_node |
生成输出资源名称的图节点的名称。例如:output_resource: /projects/123/locations/us-central1/corpora/my-corpus/dataSchemas/my-schema producer_node: occupancy-count |
key |
输出资源的键,在同一生产者节点中必须是唯一的。一个生产者节点可以输出多个输出资源,该键可用于匹配相应的输出资源。 |
MonitoringConfig
应用的监控相关配置。
字段 | |
---|---|
enabled |
此应用是否已启用监控。 |
BillingMode
应用的结算模式
枚举 | |
---|---|
BILLING_MODE_UNSPECIFIED |
默认值。 |
PAYG |
随用随付结算模式。 |
MONTHLY |
按月结算模式。 |
州
申请状态
枚举 | |
---|---|
STATE_UNSPECIFIED |
默认值。如果省略状态,则使用此值。 |
CREATED |
状态为“已创建”。 |
DEPLOYING |
状态为 DEPLOYING。 |
DEPLOYED |
状态为“已部署”。 |
UNDEPLOYING |
状态为 UNDEPLOYING。 |
DELETED |
状态为“已删除”。 |
ERROR |
状态 ERROR。 |
CREATING |
状态为“正在创建”。 |
UPDATING |
状态更新中。 |
DELETING |
状态:正在删除。 |
FIXING |
状态修复。 |
ApplicationConfigs
用于存储应用图表的消息。
字段 | |
---|---|
nodes[] |
应用图中的节点列表。 |
ApplicationInstance
创建实例的消息。
字段 | |
---|---|
instance_id |
必需。发出请求的对象的 ID。 |
instance |
必需。要创建的资源。 |
ApplicationNodeAnnotation
用于描述应用节点专用注解的消息。此消息与 StreamWithAnnotation.NodeAnnotation 重复。
字段 | |
---|---|
node |
应用图的节点名称。 |
annotations[] |
节点专用数据流注释。 |
ApplicationStreamInput
有关单个串流输入配置的消息。
字段 | |
---|---|
stream_with_annotation |
素材资源
资产是语料库中的资源。它表示语料库中的媒体对象,包含元数据和其他资源注释。您可以对资源应用不同的特征来生成注释。用户可以指定与目标资产相关的注释。
字段 | |
---|---|
name |
资产的资源名称。格式: |
ttl |
所有媒体资产、关联的元数据和搜索文档的有效期。如果未设置,则会使用父语料库资源中的默认 TTL。 |
asset_gcs_source |
仅限输出。与此素材资源关联的原始 Cloud Storage 来源 URI。 |
AssetSource
资产的来源。
字段 | |
---|---|
联合字段
|
|
asset_gcs_source |
资产的来源是 Cloud Storage。 |
asset_content_data |
资产的来源来自内容字节。 |
AssetContentData
资源的内容。
字段 | |
---|---|
asset_content_data |
|
AssetGcsSource
资产来源是 Cloud Storage。
字段 | |
---|---|
gcs_uri |
Cloud Storage URI。 |
AttributeValue
表示运算符属性的实际值。
字段 | |
---|---|
联合字段 value 。属性值。value 只能是下列其中一项: |
|
i |
int。 |
f |
浮点数。 |
b |
bool。 |
s |
字符串。 |
AutoscalingMetricSpec
用于定义目标资源利用率(CPU 利用率、加速器的工作周期等)的指标规范,以便计算所需的副本数。
字段 | |
---|---|
metric_name |
必需。资源指标名称。支持的指标:
|
target |
给定指标的目标资源利用率(以百分比 [1% -100%] 表示);一旦实际使用率与目标值偏差超过一定百分比,机器副本就会发生变化。如果未提供,则默认值为 60(表示 60%)。 |
BatchRunProcessRequest
用于批量运行进程的请求消息。
字段 | |
---|---|
parent |
必需。由要创建的所有进程共享的父级资源。 |
requests[] |
必需。创建进程请求。 |
options |
可选。批处理选项。 |
batch_id |
仅限输出。批次 ID。 |
BatchRunProcessOptions
批处理选项。
字段 | |
---|---|
retry_count |
每个进程的重试次数。默认值:3。 |
batch_size |
批量大小。默认值:5,最大值:100。 |
BatchRunProcessResponse
用于批量运行进程的响应消息。
字段 | |
---|---|
batch_id |
批次 ID。 |
processes[] |
创建了进程。 |
BigQueryConfig
BigQuery 处理器的配置消息。
字段 | |
---|---|
table |
用于将注释提取到 Vision AI Platform 的 BigQuery 表资源。 |
cloud_function_mapping |
数据架构:默认情况下,Vision AI 应用会尝试使用以下架构将注释写入目标 BigQuery 表: ingestion_time:TIMESTAMP,原始数据的提取时间。 application:STRING,生成注解的应用的名称。 instance:STRING,生成注解的实例的 ID。 node:STRING,生成注解的应用图节点的名称。 annotation:STRING 或 JSON,实际注释 protobuf 将转换为 json 字符串,其中 bytes 字段为 base64 编码的字符串。它可以写入字符串或 Json 类型的列。 如需将注释数据转发到现有 BigQuery 表,客户需要确保架构的兼容性。该映射将应用节点名称映射到其对应的 Cloud Functions 端点,以便将注释直接转换为 google.cloud.bigquery.storage.v1.AppendRowsRequest(应仅设置 avro_rows 或 proto_rows)。如果已配置,相应应用节点生成的注释将先发送到 Cloud Functions,然后再转发到 BigQuery。 如果默认表架构不适用,客户可以使用 CloudFunction 将注释输出从 Vision AI 应用转换为任意 BigQuery 表架构。* Cloud Functions 函数将收到 AppPlatformCloudFunctionRequest,其中 annotations 字段将采用 Vision AI 注释的 JSON 格式。* Cloud 函数应返回 AppPlatformCloudFunctionResponse,并将 AppendRowsRequest 存储在 annotations 字段中。* 如需删除注释,只需清除返回的 AppPlatformCloudFunctionResponse 中的 annotations 字段即可。 |
create_default_table_if_not_exists |
如果为 true,则当指定表不存在时,App Platform 将使用默认架构创建 BigQuery DataSet 和 BigQuery 表。如果指定了任何 Cloud Functions 自定义架构,则此方法不起作用,因为系统不知道您想要的架构。JSON 列将用于 App Platform 创建的默认表。 |
BoolValue
字段 | |
---|---|
value |
|
渠道
用于描述 Channel 对象的消息。
字段 | |
---|---|
name |
资源的名称。 |
create_time |
仅限输出。创建时间戳。 |
update_time |
仅限输出。更新时间戳。 |
labels |
标签以键值对的形式提供。 |
annotations |
注解,允许客户端存储少量任意数据。 |
stream |
必需。与此系列相关联的直播。 |
event |
必需。与此系列活动相关联的活动。 |
CircleArea
圆形区域的表示。
字段 | |
---|---|
latitude |
圆形区域中心的纬度。度数 [-90 到 90] |
longitude |
圆形区域中心的经度。度数 [-180 到 180] |
radius_meter |
圆形区域的半径(以米为单位)。 |
ClassificationPredictionResult
图片和文本分类的预测输出格式。
字段 | |
---|---|
ids[] |
已识别的 AnnotationSpec 的资源 ID。 |
display_names[] |
已识别的 AnnotationSpec 的显示名称,顺序与 ID 一致。 |
confidences[] |
模型对预测 ID 正确性的置信度,值越高,置信度越高。顺序与 ID 匹配。 |
ClipAssetRequest
ClipAsset API 的请求消息。
字段 | |
---|---|
name |
必需。要请求剪辑的资产的资源名称。格式: |
temporal_partition |
必需。请求剪辑的时间范围。 |
ClipAssetResponse
ClipAsset API 的响应消息。
字段 | |
---|---|
time_indexed_uris[] |
用于下载涵盖所请求时间范围的视频片段的有序签名 URI 列表。 |
TimeIndexedUri
带有相应时间范围的已签名 URI。
字段 | |
---|---|
temporal_partition |
URI 对应的视频的时间范围。 |
uri |
用于下载视频片段的已签名 URI。 |
集群
用于描述 Cluster 对象的消息。
字段 | |
---|---|
name |
仅限输出。资源的名称。 |
create_time |
仅限输出。创建时间戳。 |
update_time |
仅限输出。更新时间戳。 |
labels |
标签作为键值对 |
annotations |
注解,允许客户端存储少量任意数据。 |
dataplane_service_endpoint |
仅限输出。数据平面服务的 DNS 名称 |
state |
仅限输出。集群的当前状态。 |
psc_target |
仅限输出。Private Service Connect 服务目标名称。 |
州
集群的当前状态。
枚举 | |
---|---|
STATE_UNSPECIFIED |
未设置。 |
PROVISIONING |
“PROVISIONING”状态表示正在创建集群。 |
RUNNING |
“RUNNING”状态表示集群已创建并且完全可用。 |
STOPPING |
“STOPPING”状态表示集群正在被删除。 |
ERROR |
“ERROR”状态表示集群无法使用。系统会自动将其删除。 |
ClusterInfo
字段 | |
---|---|
streams_count |
集群中活跃数据流的数量。 |
processes_count |
集群中活跃进程的数量。 |
集合
集合是语料库中的资源。它充当原始资源引用的容器。
字段 | |
---|---|
name |
仅限输出。集合的资源名称。格式: |
display_name |
可选。要显示的集合名称。名称不得超过 256 个字符。 |
description |
可选。合集的说明。长度不得超过 25,000 个字符。 |
CollectionItem
CollectionItem 是集合中的项。每个项都是对集合中原始资源的引用。
字段 | |
---|---|
collection |
必需。此项所属的集合名称。格式: |
type |
必需。内容的类型。 |
item_resource |
必需。CollectionItem 的名称。其格式取决于上述 |
类型
CollectionItem 类型。
枚举 | |
---|---|
TYPE_UNSPECIFIED |
默认类型的项绝不应出现。 |
ASSET |
素材资源类型项。 |
CommitRequest
用于明确提交读取进度的邮件。
仅当在初始设置请求中设置了 ReceivePacketsControlledMode
时,才能使用此参数。
字段 | |
---|---|
offset |
要提交的偏移量。 |
ControlledMode
受控模式下接收器的选项。
字段 | |
---|---|
fallback_starting_offset |
如果指定的起始偏移量不可用,则应回退到此逻辑起点。 可以是下列值之一: “begin”:从最早可用的消息开始读取。 “end”:仅读取未来的消息。 |
联合字段 starting_offset 。这是开始接收数据的偏移量。starting_offset 只能是下列其中一项: |
|
starting_logical_offset |
此值可设置为以下逻辑起点: “begin”:从最早可用的消息开始读取。 “most-recent”:系统会从最新的可用消息中读取。 “end”:仅读取未来的消息。 “存储”:这将从上次提交的偏移量之后读取。这是唯一可恢复进度的选项;所有其他选项都会单方面跳转。 |
语料库
语料库是一组要管理的媒体内容。在一个语料库中,媒体共享相同的数据架构。搜索范围也仅限于单个语料库。
字段 | |
---|---|
name |
语料库的资源名称。格式: |
display_name |
必需。要在界面中显示的语料库名称。名称不得超过 32 个字符。 |
description |
可选。语料库的说明。长度不得超过 25,000 个字符。 |
default_ttl |
可选。没有素材资源级用户定义的 TTL 时,该语料库下所有素材资源的默认 TTL 值。对于 STREAM_VIDEO 类型的语料库,此字段是必需的,并且允许的最大 default_ttl 为 10 年。 |
type |
可选。语料库中资产的类型。 |
search_capability_setting |
语料库级别的默认搜索功能设置。 |
类型
语料库中资产的类型。
枚举 | |
---|---|
TYPE_UNSPECIFIED |
默认类型,不应使用。如果使用此默认类型,则语料库将创建为 STREAM_VIDEO 语料库。 |
STREAM_VIDEO |
资产是直播视频资产。 |
IMAGE |
素材资源是图片。 |
VIDEO_ON_DEMAND |
资产是指视频素材资源。 |
CreateAnalysisRequest
创建分析时显示的消息。
字段 | |
---|---|
parent |
必需。父级的值。 |
analysis_id |
必需。发出请求的对象的 ID。 |
analysis |
必需。要创建的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateAnnotationRequest
CreateAnnotation 的请求消息。
字段 | |
---|---|
parent |
必需。将在其中创建此注解的父级资源。格式: |
annotation |
必需。要创建的注解。 |
annotation_id |
可选。要用于注释的 ID,如果用户选择指定,该 ID 将成为注释资源名称的最后一个组成部分。否则,系统会生成注释 ID。 此值应不超过 63 个字符,有效字符为 /[a-z][0-9]-/。第一个字符必须是字母,最后一个字符可以是字母或数字。 |
CreateApplicationInstancesRequest
用于向应用添加数据流输入的消息。
字段 | |
---|---|
name |
必需。要检索的应用的名称。格式:“projects/{project}/locations/{location}/applications/{application}” |
application_instances[] |
必需。正在创建的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateApplicationInstancesResponse
此类型没有字段。
CreateApplicationInstance 响应消息。
CreateApplicationRequest
用于创建应用的消息。
字段 | |
---|---|
parent |
必需。父级的值。 |
application_id |
必需。发出请求的对象的 ID。 |
application |
必需。要创建的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateAssetRequest
CreateAssetRequest 的请求消息。
字段 | |
---|---|
parent |
必需。要创建此素材资源的父资源。格式: |
asset |
必需。要创建的资产。 |
asset_id |
可选。要用于素材资源的 ID,如果用户选择指定,该 ID 将成为素材资源资源名称的最后一个组成部分。否则,系统会生成资产 ID。 此值应不超过 63 个字符,有效字符为 /[a-z][0-9]-/。第一个字符必须是字母,最后一个字符可以是字母或数字。 |
CreateClusterRequest
创建集群的消息。
字段 | |
---|---|
parent |
必需。父级的值。 |
cluster_id |
必需。发出请求的对象的 ID。 |
cluster |
必需。要创建的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateCollectionMetadata
CreateCollectionRequest 的元数据消息
字段 | |
---|---|
operation_metadata |
长时间运行的操作的常见元数据。 |
CreateCollectionRequest
CreateCollection 的请求消息。
字段 | |
---|---|
parent |
必需。将在其中创建此集合的父级资源。格式: |
collection |
必需。要创建的集合资源。 |
collection_id |
可选。要用于合集的 ID,该 ID 将成为资源名称的最后一个组成部分(如果用户选择指定)。否则,系统会生成合集 ID。 此值应不超过 55 个字符,有效字符为 /[a-z][0-9]-/。第一个字符必须是字母,最后一个字符可以是字母或数字。 |
CreateCorpusMetadata
CreateCorpus API 的元数据。
字段 | |
---|---|
create_time |
创建语料库操作的创建时间。 |
update_time |
创建语料库操作的更新时间。 |
CreateCorpusRequest
CreateCorpus API 的请求消息。
字段 | |
---|---|
parent |
必需。表单: |
corpus |
必需。要创建的语料库。 |
CreateDataSchemaRequest
CreateDataSchema 的请求消息。
字段 | |
---|---|
parent |
必需。将在其中创建此数据架构的父级资源。格式: |
data_schema |
必需。要创建的数据架构。 |
CreateDraftRequest
创建草稿的消息。
字段 | |
---|---|
parent |
必需。父级的值。 |
draft_id |
必需。发出请求的对象的 ID。 |
draft |
必需。要创建的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateEventRequest
用于创建事件的消息。
字段 | |
---|---|
parent |
必需。父级的值。 |
event_id |
必需。发出请求的对象的 ID。 |
event |
必需。要创建的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateIndexEndpointMetadata
CreateIndexEndpoint 的元数据消息。
字段 | |
---|---|
operation_metadata |
长时间运行的操作的常见元数据。 |
CreateIndexEndpointRequest
CreateIndexEndpoint 的请求消息。
字段 | |
---|---|
parent |
必需。格式: |
index_endpoint_id |
可选。要用于 IndexEndpoint 的 ID,该 ID 将成为 IndexEndpoint 资源名称的最后一个组成部分(如果用户指定了该 ID)。否则,系统会自动生成 IndexEndpoint ID。 此值应不超过 63 个字符,有效字符为 a-z、0-9 和短划线 (-)。第一个字符必须是字母,最后一个字符必须是字母或数字。 |
index_endpoint |
必需。要创建的资源。 |
CreateIndexMetadata
CreateIndexRequest 的元数据消息
字段 | |
---|---|
operation_metadata |
长时间运行的操作的常见元数据。 |
CreateIndexRequest
创建索引的消息。
字段 | |
---|---|
parent |
必需。父级的值。创建此索引时所依赖的语料库的资源名称。格式: |
index_id |
可选。索引的 ID。这将成为该索引的最终资源名称。如果用户未指定此值,系统会生成此值。 此值应不超过 63 个字符,有效字符为 /[a-z][0-9]-/。第一个字符必须是字母,最后一个字符可以是字母或数字。 |
index |
必需。正在创建的索引。 |
CreateOperatorRequest
用于创建运算符的消息。
字段 | |
---|---|
parent |
必需。父级的值。 |
operator_id |
必需。发出请求的对象的 ID。 |
operator |
必需。要创建的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateProcessRequest
用于创建进程的消息。
字段 | |
---|---|
parent |
必需。父级的值。 |
process_id |
必需。发出请求的对象的 ID。 |
process |
必需。要创建的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateProcessorRequest
用于创建处理器的消息。
字段 | |
---|---|
parent |
必需。父级的值。 |
processor_id |
必需。发出请求的对象的 ID。 |
processor |
必需。要创建的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateSearchConfigRequest
CreateSearchConfig 的请求消息。
字段 | |
---|---|
parent |
必需。将在其中创建此搜索配置的父级资源。格式: |
search_config |
必需。要创建的搜索配置。 |
search_config_id |
必需。要用于新搜索配置的 ID。将成为 SearchConfig 资源名称的最后一个组成部分。此值最多应为 63 个字符,有效字符为 /[a-z][0-9]-_/。第一个字符必须是字母,最后一个字符可以是字母或数字。 |
CreateSearchHypernymRequest
用于创建 SearchHypernym 的请求消息。
字段 | |
---|---|
parent |
必需。将在其中创建此 SearchHypernym 的父级资源。格式: |
search_hypernym |
必需。要创建的 SearchHypernym。 |
search_hypernym_id |
可选。搜索超名词 ID。如果省略,系统会生成一个随机 UUID。 |
CreateSeriesRequest
用于创建系列图书的消息。
字段 | |
---|---|
parent |
必需。父级的值。 |
series_id |
必需。发出请求的对象的 ID。 |
series |
必需。要创建的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
CreateStreamRequest
用于创建数据流的消息。
字段 | |
---|---|
parent |
必需。父级的值。 |
stream_id |
必需。发出请求的对象的 ID。 |
stream |
必需。要创建的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
条件
应用于当前搜索结果的过滤条件。
字段 | |
---|---|
field |
用于应用过滤条件的 UGA 字段或 ML 字段。 |
fetch_matched_annotations |
如果为 true,则返回与此条件匹配的查询注释。此选项仅适用于包含条件(即非排除条件),且包含分区级注解。它支持以下数据类型:- INTEGER - FLOAT - STRING(仅限 DataSchema.SearchStrategy.EXACT_SEARCH)- BOOLEAN |
联合字段
|
|
text_array |
与字段关联的文本值。 |
int_range_array |
与字段关联的整数范围。 |
float_range_array |
与字段关联的浮点范围。 |
date_time_range_array |
与字段关联的日期时间范围。 |
geo_location_array |
地理位置数组。 |
bool_value |
布尔值。 |
CustomProcessorSourceInfo
描述自定义处理器的来源信息。
字段 | |
---|---|
source_type |
包含自定义处理器功能的原始产品。 |
additional_info |
仅限输出。与导入的自定义处理器相关的其他信息。数据由应用平台在创建处理器期间填充。 |
model_schema |
用于指定模型签名的模型架构文件。对于 VERTEX_CUSTOM 模型,实例架构是必需的。如果在创建处理器期间未指定实例架构,VisionAI 平台会尝试从 Vertex 获取该架构;如果该架构不存在,则创建将失败。 |
联合字段 artifact_path 。App Platform 加载自定义处理器工件的路径。artifact_path 只能是下列其中一项: |
|
vertex_model |
托管在 Vertex AI 平台中的原始模型的资源名称。 |
product_recognizer_artifact |
商品识别器的工件。 |
ModelSchema
架构定义为 OpenAPI 3.0.2 架构对象。
字段 | |
---|---|
instances_schema |
YAML 文件的 Cloud Storage 位置,该文件用于定义预测和说明请求中使用的单个实例的格式。 |
parameters_schema |
YAML 文件的 Cloud Storage 位置,该文件用于定义预测和说明参数。 |
predictions_schema |
YAML 文件的 Cloud Storage 位置,该文件用于定义单个预测或说明的格式。 |
ProductRecognizerArtifact
消息描述商品识别器工件。
字段 | |
---|---|
retail_product_recognition_index |
必需。RetailProductRecognitionIndex 的资源名称。格式为“projects/*/locations/*/retailCatalogs/*/retailProductRecognitionIndexes/*” |
vertex_model |
可选。托管在 Vertex AI Platform 中的嵌入模型的资源名称。 |
SourceType
导入的自定义处理器的来源类型。
枚举 | |
---|---|
SOURCE_TYPE_UNSPECIFIED |
未指定来源类型。 |
VERTEX_AUTOML |
来自 Vertex AutoML 产品的自定义处理器。 |
VERTEX_CUSTOM |
来自 Vertex 的通用自定义模型的自定义处理器。 |
PRODUCT_RECOGNIZER |
商品识别器的来源。 |
DataSchema
数据架构指示系统如何解读用户指定的注释。
字段 | |
---|---|
name |
数据架构的资源名称,格式为: |
key |
必需。此数据架构的键。此键应与用户指定的注释的键匹配,并且在语料库内是唯一的。此值最多可包含 63 个字符,有效字符为 /[a-z][0-9]-/。第一个字符必须是字母,最后一个字符可以是字母或数字。 |
schema_details |
与键对应的架构详细信息。 |
DataSchemaDetails
数据架构详情指示与用户指定注解的键对应的数据类型和数据结构。
字段 | |
---|---|
type |
注释的类型。 |
proto_any_config |
适用于任何类型的 protobuf 的配置。 |
list_config |
列表数据类型的配置。 |
customized_struct_config |
CustomizedStruct 数据类型的配置。 |
granularity |
与此 DataSchema 关联的精细程度。 |
search_strategy |
要应用于上述 |
CustomizedStructConfig
CUSTOMIZED_STRUCT
数据类型的配置。
字段 | |
---|---|
field_schemas |
直接子元素数据架构。 |
DataType
注解的数据类型。
枚举 | |
---|---|
DATA_TYPE_UNSPECIFIED |
未指定类型。 |
INTEGER |
整数类型。允许的搜索策略:- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。支持按 IntRangeArray 进行查询。 |
FLOAT |
浮点类型。允许的搜索策略:- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。支持按 FloatRangeArray 进行查询。 |
STRING |
字符串类型。允许的搜索策略:- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH、- DataSchema.SearchStrategy.SMART_SEARCH。 |
DATETIME |
支持的格式:%Y-%m-%dT%H:%M:%E*S%E*z (absl::RFC3339_full) %Y-%m-%dT%H:%M:%E*S %Y-%m-%dT%H:%M%E*z %Y-%m-%dT%H:%M %Y-%m-%dT%H%E*z %Y-%m-%dT%H %Y-%m-%d%E*z %Y-%m-%d %Y-%m %Y 允许的搜索策略:- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。支持按 DateTimeRangeArray 进行查询。 |
GEO_COORDINATE |
地理坐标类型。允许的搜索策略:- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。支持按 GeoLocationArray 进行查询。 |
PROTO_ANY |
输入内容以传递 annotations.proto 中提供的任何 proto。仅限内部使用。可用的 proto 类型及其对应的搜索行为:- ImageObjectDetectionPredictionResult,允许对 display_names 使用 SMART_SEARCH 和 NO_SEARCH。- ClassificationPredictionResult,允许对 display_names 使用 SMART_SEARCH 和 NO_SEARCH。- ImageSegmentationPredictionResult,允许 NO_SEARCH。- VideoActionRecognitionPredictionResult,允许对 display_name 和 NO_SEARCH 使用 SMART_SEARCH。- VideoObjectTrackingPredictionResult,允许对 display_name 和 NO_SEARCH 使用 SMART_SEARCH。- VideoClassificationPredictionResult,允许对 display_name 和 NO_SEARCH 使用 SMART_SEARCH。- OccupancyCountingPredictionResult,允许对 stats.full_frame_count.count 使用 EXACT_SEARCH 和 NO_SEARCH。- ObjectDetectionPredictionResult,允许对 identified_boxes.entity.label_string 使用 SMART_SEARCH 和 NO_SEARCH。 |
BOOLEAN |
布尔值类型。允许的搜索策略:- DataSchema.SearchStrategy.NO_SEARCH、- DataSchema.SearchStrategy.EXACT_SEARCH。 |
LIST |
列表类型。- 列表中的每个元素都必须采用完全相同的数据架构;否则,它们是无效的参数。- 列表级别无法设置搜索策略。叶节点级别可以。- 元素不能是另一个列表(不能是列表的列表)。- 元素可以是 CUSTOMIZED_STRUCT,图层数量上限为 10。 |
CUSTOMIZED_STRUCT |
结构体类型。- SearchStrategy:* 数据架构为 CUSTOMIZED_STRUCT 时无法设置搜索策略。* 叶节点元素允许根据元素的 SearchStrategy 限制设置搜索策略。- 嵌套层限制:* 数据架构为 CUSTOMIZED_STRUCT 时,其字段也可以是 CUSTOMIZED_STRUCT,但总层数限制为 10。 |
细化程度
此 DataSchema 下的注释的粒度。
枚举 | |
---|---|
GRANULARITY_UNSPECIFIED |
未指定粒度。 |
GRANULARITY_ASSET_LEVEL |
资源级粒度(注释不得包含分区信息)。 |
GRANULARITY_PARTITION_LEVEL |
分区级粒度(注释必须包含分区信息)。 |
ListConfig
LIST
数据类型的配置。
字段 | |
---|---|
value_schema |
列表中相应值的数据架构。 |
ProtoAnyConfig
PROTO_ANY
数据类型的配置。
字段 | |
---|---|
type_uri |
proto 消息的类型 URI。 |
SearchStrategy
key
的注解值的搜索策略。
字段 | |
---|---|
search_strategy_type |
要应用于上述 |
SearchStrategyType
要应用于注释键的搜索策略类型。
枚举 | |
---|---|
NO_SEARCH |
上述 key 的注释值将不可搜索。 |
EXACT_SEARCH |
使用 key 进行搜索时,该值必须与已提取的注释值完全相同。 |
SMART_SEARCH |
使用 key 进行搜索时,仓库会根据注释值的语义执行广泛搜索。 |
DataType
所有支持的数据类型。
枚举 | |
---|---|
DATA_TYPE_UNSPECIFIED |
DataType 的默认值。 |
VIDEO |
视频数据类型,例如 H264。 |
IMAGE |
图片数据类型。 |
PROTO |
Protobuf 数据类型,通常用于一般数据 blob。 |
PLACEHOLDER |
占位符数据类型,适用于支持任何数据类型的通用输入处理器。在实例部署期间,此类将被实例化并替换为具体的底层 DataType 。 |
DateTimeRange
日期时间范围类型。
字段 | |
---|---|
start |
开始日期时间。 |
end |
结束数据时间。 |
DateTimeRangeArray
日期时间范围值的列表。
字段 | |
---|---|
date_time_ranges[] |
日期时间范围。 |
DedicatedResources
专用于 DeployedModel 且需要更高程度的手动配置的资源的说明。
字段 | |
---|---|
machine_spec |
必需。不可变。预测所使用的单个机器的规范。 |
min_replica_count |
必需。不可变。始终在其中部署此 DeployedModel 的机器副本的数量下限。此值必须大于或等于 1。 如果 DeployedModel 的流量增加,系统可能会将其动态部署到更多副本上,而随着流量减少,系统可能会释放其中一些额外的副本。 |
max_replica_count |
不可变。当相应 DeployedModel 的流量增加时,可在其中部署的副本数量上限。如果请求的值过大,部署将出错,但如果部署成功,则可以保证将模型扩缩到该数量的副本(除非服务中断)。如果 DeployedModel 的流量超出其副本的最大处理能力,系统会丢弃部分流量。如果未提供此值,则将使用 此字段的值会影响 Vertex CPU 和 GPU 配额的费用。具体而言,您需要按以下费率付费:(max_replica_count * 所选机器类型中的核心数) 和 (max_replica_count * 所选机器类型中每个副本的 GPU 数量)。 |
autoscaling_metric_specs[] |
不可变。用于替换资源利用率指标(CPU 利用率、加速器的占空百分比等)目标值的指标规范(如果未设置,则默认为 60)。每个指标最多只能有一个条目。 如果 如果 例如,在线预测情况下,如果您想将目标 CPU 利用率替换为 80,则应将 |
DeleteAnalysisRequest
删除分析报告时显示的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteAnnotationRequest
DeleteAnnotation API 的请求消息。
字段 | |
---|---|
name |
必需。要删除的注释的名称。格式: |
DeleteApplicationInstancesRequest
用于从应用中移除串流输入的消息。
字段 | |
---|---|
name |
必需。要检索的应用的名称。格式:“projects/{project}/locations/{location}/applications/{application}” |
instance_ids[] |
必需。发出请求的对象的 ID。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteApplicationInstancesResponse
此类型没有字段。
DeleteApplicationInstance 响应消息。
DeleteApplicationRequest
用于删除应用的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
force |
可选。如果设置为 true,则此应用中的所有实例和草稿也会被删除。(否则,只有当应用没有实例和草稿时,请求才有效。) |
DeleteAssetMetadata
此类型没有字段。
嵌入在 metadata
字段中的 DeleteAsset API 的元数据。
DeleteAssetRequest
DeleteAsset 的请求消息。
字段 | |
---|---|
name |
必需。要删除的资产的名称。格式: |
DeleteClusterRequest
删除集群的消息。
字段 | |
---|---|
name |
必需。资源的名称 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
force |
可选。如果设置为 true,集群的所有子资源都将被删除。(否则,只有当集群没有子项时,请求才有效。) |
DeleteCollectionMetadata
DeleteCollectionRequest 的元数据消息
字段 | |
---|---|
operation_metadata |
长时间运行的操作的常见元数据。 |
DeleteCollectionRequest
DeleteCollectionRequest 的请求消息。
字段 | |
---|---|
name |
必需。要删除的集合的名称。格式: |
DeleteCorpusRequest
DeleteCorpus 的请求消息。
字段 | |
---|---|
name |
必需。要删除的语料库的资源名称。 |
DeleteDataSchemaRequest
DeleteDataSchema 的请求消息。
字段 | |
---|---|
name |
必需。要删除的数据架构的名称。格式: |
DeleteDraftRequest
删除草稿时显示的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteEventRequest
删除活动时显示的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteIndexEndpointMetadata
DeleteIndexEndpoint 的元数据消息。
字段 | |
---|---|
operation_metadata |
长时间运行的操作的常见元数据。 |
DeleteIndexEndpointRequest
DeleteIndexEndpoint 的请求消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
DeleteIndexMetadata
此类型没有字段。
DeleteIndexRequest 的元数据消息
DeleteIndexRequest
DeleteIndex 的请求消息。
字段 | |
---|---|
name |
必需。要删除的索引的名称。格式: |
DeleteOperatorRequest
删除运营商时显示的消息
字段 | |
---|---|
name |
必需。资源的名称 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteProcessRequest
删除进程的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteProcessorRequest
用于删除处理器的消息。
字段 | |
---|---|
name |
必需。资源的名称 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteSearchConfigRequest
DeleteSearchConfig 的请求消息。
字段 | |
---|---|
name |
必需。要删除的搜索配置的名称。格式: |
DeleteSearchHypernymRequest
用于删除 SearchHypernym 的请求消息。
字段 | |
---|---|
name |
必需。要删除的 SearchHypernym 的名称。格式: |
DeleteSeriesRequest
删除系列图书时显示的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeleteStreamRequest
用于删除数据流的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
DeployApplicationRequest
部署应用的消息。
字段 | |
---|---|
name |
必需。要检索的应用的名称。格式:“projects/{project}/locations/{location}/applications/{application}” |
validate_only |
如果设置了此参数,系统会验证请求并预览应用图,但不会实际部署应用图。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
enable_monitoring |
可选。是否在部署时为应用启用监控。 |
DeployApplicationResponse
此类型没有字段。
RPC 请求消息。DeployApplication 响应消息。
DeployIndexMetadata
DeployIndex 的元数据消息。
字段 | |
---|---|
operation_metadata |
长时间运行的操作的常见元数据。 |
deployed_index |
仅限输出。要部署的索引。 |
DeployIndexRequest
DeployIndex 的请求消息。
字段 | |
---|---|
index_endpoint |
必需。索引部署到的 IndexEndpoint。格式: |
deployed_index |
必需。要部署的索引。 |
DeployIndexResponse
此类型没有字段。
操作完成后的 DeployIndex 响应。
DeployRetailProductRecognitionIndexResponse
此类型没有字段。
DeployRetailProductRecognitionIndex 响应消息。
DeployedIndex
索引的部署。
字段 | |
---|---|
index |
必需。已部署的索引的名称。格式: |
DeployedIndexReference
指向 DeployedIndex。
字段 | |
---|---|
index_endpoint |
不可变。IndexEndpoint 的资源名称。 |
草稿
用于描述 Draft 对象的消息
字段 | |
---|---|
name |
资源名称 |
create_time |
仅限输出。[仅限输出] 创建时间戳 |
update_time |
仅限输出。[仅限输出] 创建时间戳 |
labels |
标签作为键值对 |
display_name |
必需。解决方案的易记显示名称。 |
description |
此应用的说明。 |
draft_application_configs |
尚未更新为应用的草稿应用配置。 |
EagerMode
此类型没有字段。
在 eager 模式下接收器的选项。
事件
用于描述 Event 对象的消息。
字段 | |
---|---|
name |
资源的名称。 |
create_time |
仅限输出。创建时间戳。 |
update_time |
仅限输出。更新时间戳。 |
labels |
标签以键值对的形式提供。 |
annotations |
注解,允许客户端存储少量任意数据。 |
alignment_clock |
用于联接数据流的时钟。 |
grace_period |
用于清理活动的宽限期。这是控制器在删除事件之前等待的时间。在此期间,如果活动有任何有效渠道。系统会忽略在 grace_period 后删除事件的操作。 |
时钟
用于联接数据流的时钟。
枚举 | |
---|---|
CLOCK_UNSPECIFIED |
未指定时钟。 |
CAPTURE |
使用捕获数据的时间戳。客户端需要同步时钟。 |
INGEST |
使用收到数据的时间戳。 |
EventUpdate
事件更新消息。
字段 | |
---|---|
stream |
事件所附加的直播的名称。 |
event |
事件的名称。 |
series |
系列图书的名称。 |
update_time |
事件更新发生的时间戳。 |
offset |
消息的偏移量,用于确认消息接收。 |
EventUpdateFilter
EventUpdateFilter 是监视器可以使用来指定要接收哪些事件更新的过滤条件。
字段 | |
---|---|
联合字段
|
|
special_mode |
除特定时间戳之外的特殊模式。 |
specific_time |
事件更新发生后的特定时间戳。 |
SpecialMode
除特定时间戳之外的特殊模式。
枚举 | |
---|---|
SPECIAL_MODE_UNSPECIFIED |
未指定特殊模式。 |
BEGINNING |
“BEGINNING special mode”表示所有当前可用的事件和传入的事件更新。 |
LATEST |
“最新”特殊模式表示仅显示最新事件和即将到来的事件更新。 |
EventUpdateType
事件更新的类型。未来可扩展为适用于其他用例,例如 EVENT_DETACHED_FROM_STREAM 等。
枚举 | |
---|---|
EVENT_UPDATE_TYPE_UNSPECIFIED |
未指定事件更新类型。 |
EVENT_AVAILABLE_ON_STREAM |
事件可从流中读取。 |
EVENT_HEARTBEAT |
用于跟踪 gRPC 连接活跃性的心跳消息。 |
ExportRetailProductRecognitionIndexCoverageResponse
此类型没有字段。
对导出 RetailProductRecognitionIndex 覆盖率文件的响应消息。
FacetBucket
用于存储细分值、选择状态和元数据。
字段 | |
---|---|
selected |
是否选择了一个细分维度存储分区。此字段表示用户选择的细分条件。它由前端在 SearchVideosRequest 中设置。 |
联合字段 bucket_value 。与分面关联的分桶。例如,“球队”细分维度的分桶可以是“49ers”“patriots”等;“球员”细分维度的分桶可以是“tom brady”“drew brees”等。bucket_value 只能是以下之一: |
|
value |
奇异值。 |
range |
范围值。 |
范围
要应用分面的值范围 [start, end)。
字段 | |
---|---|
start |
范围的起始值。不存在表示某个边界(例如 -inf)。 |
end |
范围的结束值。不存在表示某个边界(例如 inf)。 |
FacetBucketType
不同类型的细分桶。
枚举 | |
---|---|
FACET_BUCKET_TYPE_UNSPECIFIED |
未指定类型。 |
FACET_BUCKET_TYPE_VALUE |
值类型。 |
FACET_BUCKET_TYPE_DATETIME |
日期时间类型。 |
FACET_BUCKET_TYPE_FIXED_RANGE |
固定范围类型。 |
FACET_BUCKET_TYPE_CUSTOM_RANGE |
“自定义范围”类型。 |
FacetGroup
一组要在后端和前端之间来回传递的细分桶。
字段 | |
---|---|
facet_id |
细分组的唯一 ID。 |
display_name |
Facet 的显示名称。供界面用于分面呈现。 |
buckets[] |
与该分面关联的存储分区。例如,对于“球队”细分,存储分区可以是“49ers”“patriots”等。 |
bucket_type |
分面分桶类型。 |
fetch_matched_annotations |
如果为 true,则返回与此分面组的选择项匹配的注释。此选项仅适用于基于分区级注释的切面。它支持以下细分值:- INTEGER - STRING(仅限 DataSchema.SearchStrategy.EXACT_SEARCH) |
FacetProperty
面面的集中配置。
字段 | |
---|---|
mapped_fields[] |
多个维度组成的构面名称,用户可使用这些维度来优化搜索结果。 例如,用户可以添加一组具有相同键的 UGA,例如 player:adam、player:bob、player:charles。如果指定多个 mapped_fields,系统会将其值合并为最终的细分值。例如,home_team: a、home_team:b、away_team:a、away_team:c,当 facet_field = [home_team, away_team] 时,facet_value 将为 [a, b, c]。 除非这是 1:1 的细分维度(mapped_fields.size() == 1)且 mapped_field 等于父级 SearchConfig.name,否则父级还必须包含映射到相同字段的 SearchCriteriaProperty。mapped_fields 不得为空。 |
display_name |
Facet 的显示名称。供界面用于分面呈现。 |
result_size |
为一个切面返回的唯一分桶的数量上限。对于“玩家”等高基数维度,存储分区数量可能会很大。我们只会向用户返回与其最相关的前 n 个结果。如果该值小于或等于 0,则服务器将决定适当的 result_size。 |
bucket_type |
面向的细分桶类型,例如值、范围。 |
联合字段
|
|
fixed_range_bucket_spec |
固定范围细分维度分桶配置。 |
custom_range_bucket_spec |
自定义范围细分桶配置。 |
datetime_bucket_spec |
日期范围细分维度存储分区配置。 |
CustomRangeBucketSpec
如果分桶类型为 CUSTOM_RANGE,请指定值的分桶方式。以整数分桶值为例,当端点为 0、10、100 和 1000 时,我们会生成以下分面:[-inf, 0)、[0, 10)、[10, 100)、[100, 1000)、[1000, inf)。值得注意的是:- 端点必须按升序列出。否则,SearchConfig API 将拒绝该细分配置。- 端点数量少于 1 是无效规范。
字段 | |
---|---|
endpoints[] |
目前,此字段仅支持整数类型。 |
DateTimeBucketSpec
如果存储分区类型为日期,请指定日期值的分桶方式。
字段 | |
---|---|
granularity |
日期类型细分项的粒度。 |
细化程度
日期时间存储分区的粒度枚举。
枚举 | |
---|---|
GRANULARITY_UNSPECIFIED |
未指定粒度。 |
YEAR |
粒度为年。 |
MONTH |
粒度为月。 |
DAY |
粒度为天。 |
FixedRangeBucketSpec
如果分桶类型为 FIXED_RANGE,请指定值的分桶方式。如果您想创建多个粒度相同的存储分区,请使用 FixedRangeBucketSpec。以整数存储分区值为例,当 bucket_start = 0、bucket_granularity = 10、bucket_count = 5 时,此分面将通过以下存储分区汇总:[-inf, 0)、[0, 10)、[10, 20)、[20, 30)、[30, inf)。值得注意的是,bucket_count <= 1 是无效的规范。
字段 | |
---|---|
bucket_start |
分桶的下限。注意:此字段目前仅支持整数类型。 |
bucket_granularity |
存储分区粒度。注意:此字段目前仅支持整数类型。 |
bucket_count |
存储分区总数。 |
FacetValue
具有通用类型的单个值的定义。
字段 | |
---|---|
联合字段
|
|
string_value |
字符串类型值。 |
integer_value |
整数类型值。 |
datetime_value |
日期时间类型值。 |
FloatRange
浮点范围类型。
字段 | |
---|---|
start |
浮点范围的起始值。 |
end |
浮点范围的结束。 |
FloatRangeArray
浮点范围值的列表。
字段 | |
---|---|
float_ranges[] |
浮点范围值。 |
GcsOutputConfig
用于描述 GcsOutputConfig 的消息。
字段 | |
---|---|
gcs_path |
Vision AI Platform 提取注释的 Cloud Storage 路径。 |
GcsSource
输入内容所在的 Google Cloud Storage 位置。
字段 | |
---|---|
uris[] |
必需。对 Google Cloud Storage 路径的引用。 |
GeneralObjectDetectionConfig
此类型没有字段。
通用对象检测处理器的配置消息。
GenerateHlsUriRequest
GenerateHlsUri API 的请求消息。
字段 | |
---|---|
name |
必需。要请求剪辑的资产的资源名称。格式: |
temporal_partitions[] |
请求剪辑的时间范围。如果 |
live_view_enabled |
用于专门显示相应资产直播的选项,最多可显示 3 分钟的积压数据。 |
GenerateHlsUriResponse
针对 GenerateHlsUri API 的响应消息。
字段 | |
---|---|
uri |
用于下载与请求时间对应的 HLS 清单的已签名 URI。 |
temporal_partitions[] |
返回的内容的时间分区列表,按内容在数据流中显示的顺序排列。 |
GenerateRetrievalUrlRequest
GenerateRetrievalUrl API 的请求消息。
字段 | |
---|---|
name |
必需。要为其请求已签名网址的资产的资源名称。格式: |
GenerateRetrievalUrlResponse
GenerateRetrievalUrl API 的响应消息。
字段 | |
---|---|
signed_uri |
用于下载资源内容的已签名网址。 |
GenerateStreamHlsTokenRequest
用于获取访问串流 HLS 内容的授权令牌的请求消息。
字段 | |
---|---|
stream |
必需。数据流的名称。 |
GenerateStreamHlsTokenResponse
GenerateStreamHlsToken 的响应消息。
字段 | |
---|---|
token |
生成的 JWT 令牌。 调用方应将此令牌插入 HTTP 请求的授权标头中,以获取 HLS 播放列表清单和视频分块。例如:curl -H "Authorization: Bearer $TOKEN" https://domain.com/test-stream.playback/master.m3u8 |
expiration_time |
令牌的到期时间。 |
GeoCoordinate
位置坐标表示法
字段 | |
---|---|
latitude |
纬度坐标。度数 [-90 到 90] |
longitude |
经度坐标。度数 [-180 到 180] |
GeoLocationArray
营业地点列表。
字段 | |
---|---|
circle_areas[] |
圆形区域列表。 |
GetAnalysisRequest
用于获取分析的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
GetAnnotationRequest
GetAnnotation API 的请求消息。
字段 | |
---|---|
name |
必需。要检索的注释的名称。格式: |
GetApplicationRequest
用于获取应用的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
GetAssetRequest
GetAsset 的请求消息。
字段 | |
---|---|
name |
必需。要检索的资产的名称。格式:projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset} |
GetClusterRequest
用于获取集群的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
GetCollectionRequest
GetCollectionRequest 的请求消息。
字段 | |
---|---|
name |
必需。要检索的集合的名称。格式: |
GetCorpusRequest
GetCorpus 的请求消息。
字段 | |
---|---|
name |
必需。要检索的语料库的资源名称。 |
GetDataSchemaRequest
GetDataSchema 的请求消息。
字段 | |
---|---|
name |
必需。要检索的数据架构的名称。格式: |
GetDraftRequest
用于获取草稿的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
GetEventRequest
用于获取事件的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
GetIndexEndpointRequest
GetIndexEndpoint 的请求消息。
字段 | |
---|---|
name |
必需。IndexEndpoint 资源的名称。 |
GetIndexRequest
用于获取索引的请求消息。
字段 | |
---|---|
name |
必需。索引资源的名称。格式:projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index} |
GetInstanceRequest
用于获取实例的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
GetProcessRequest
用于获取进程的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
GetProcessorRequest
用于获取处理器的消息。
字段 | |
---|---|
name |
必需。资源的名称。 |
GetSearchConfigRequest
GetSearchConfig 的请求消息。
字段 | |
---|---|
name |
必需。要检索的搜索配置的名称。格式: |
GetSearchHypernymRequest
用于获取 SearchHypernym 的请求消息。
字段 | |
---|---|
name |
必需。要检索的 SearchHypernym 的名称。格式: |
ImageObjectDetectionPredictionResult
图片对象检测的预测输出格式。
字段 | |
---|---|
ids[] |
已识别的 AnnotationSpec 的资源 ID,按置信度得分从高到低排序。它是 ID 片段,而不是完整资源名称。 |
display_names[] |
已识别的 AnnotationSpec 的显示名称,顺序与 ID 一致。 |
confidences[] |
模型对预测 ID 正确性的置信度,值越高,置信度越高。顺序与 ID 匹配。 |
bboxes[] |
边界框(即图片上的矩形),用于精确定位找到的 AnnotationSpec。按 ID 的顺序给出。每个边界框都是一个由 4 个数字 |
ImageQuery
搜索端点请求的图片查询。
字段 | |
---|---|
联合字段
|
|
input_image |
以原始字节形式输入图片。 |
asset |
资产的资源名称。仅在 IMAGE 语料库类型中受支持。格式: |
ImageSegmentationPredictionResult
图片分割的预测输出格式。
字段 | |
---|---|
category_mask |
一个 PNG 图片,其中遮罩中的每个像素都代表原始图片中像素预测所属的类别。此图片的大小将与原始图片相同。您可以在模型的元数据中找到 AnntoationSpec 与颜色之间的映射。模型会选择最可能的类别,如果没有任何类别达到置信度阈值,则将像素标记为背景。 |
confidence_mask |
编码为 8 位无损 PNG 的单通道图片。图片的大小将与原始图片相同。对于特定像素,颜色越深,对相应像素的 categoryMask 中的类别正确性的信心就越低。黑色表示没有信心,白色表示完全有信心。 |
ImportAssetsMetadata
ImportAssets LRO 的元数据消息。
字段 | |
---|---|
metadata |
操作的元数据。 |
ImportAssetsRequest
ImportAssets 的请求消息。
字段 | |
---|---|
parent |
必需。要导入资源的父语料库资源。格式: |
联合字段 source 。来源。source 只能是下列其中一项: |
|
assets_gcs_uri |
该文件包含要导入的所有资源信息。* 文件采用 JSONL 格式。* 每行对应一个资产。* 每行都将转换为 InputImageAsset proto。 |
ImportAssetsResponse
此类型没有字段。
ImportAssets LRO 的响应消息。
ImportRetailProductsResponse
此类型没有字段。
操作完成后的 ImportProducts 响应。
索引
索引是语料库中的资源。它包含资产和注释的编入索引的版本。部署到端点后,用户便可搜索该索引。
字段 | |
---|---|
name |
仅限输出。索引资源的资源名称。格式: |
display_name |
可选。索引的可选用户指定显示名称。 |
description |
可选。索引的说明(可选)。 |
state |
仅限输出。索引的状态。 |
create_time |
仅限输出。创建时间戳。 |
update_time |
仅限输出。更新时间戳。 |
deployed_indexes[] |
仅限输出。对已部署的索引实例的引用。VIDEO_ON_DEMAND 语料库的索引最多只能有一个已部署的索引。IMAGE 语料库的索引可以有多个已部署的索引。 |
联合字段 asset_filter 。指定如何为此索引选择素材资源。如果未指定,则默认为 entire_corpus。UpdateIndex 中的行为:如果 update_mask 包含 asset_filter 字段路径之一,则系统将使用最新的素材资源(包括其分析数据和注释)重新构建索引。asset_filter 只能是下列其中一项: |
|
entire_corpus |
包含该语料库下的所有资产。 |
州
表示索引在其生命周期内可能会循环的不同状态的枚举。
枚举 | |
---|---|
STATE_UNSPECIFIED |
默认值。不应使用。 |
CREATING |
状态为“正在创建”。 |
CREATED |
状态为“已创建”。 |
UPDATING |
状态为“UPDATING”。 |
IndexAssetMetadata
IndexAsset 的元数据。
字段 | |
---|---|
indexing_status |
此资产的索引编制状态。 |
status |
此资产的索引编制状态。 |
start_time |
操作的开始时间。 |
update_time |
操作的更新时间。 |
IndexingStatus
资产的索引编制状态。
字段 | |
---|---|
state |
此资产的索引编制状态。 |
status_message |
用于描述状态的详细消息。 |
州
此素材资源索引编制状态的枚举。
枚举 | |
---|---|
STATE_UNSPECIFIED |
默认进程状态绝不应发生。 |
IN_PROGRESS |
正在编入索引。 |
SUCCEEDED |
该流程已成功完成。 |
FAILED |
该流程失败。 |
IndexAssetRequest
IndexAsset 的请求消息。
字段 | |
---|---|
name |
必需。要编入索引的资产的资源名称。格式: |
index |
可选。索引的名称。格式: |
IndexAssetResponse
此类型没有字段。
IndexAsset 的响应消息。
IndexEndpoint
表示 IndexEndpoint 资源的消息。ImageIndex 会部署到其中。
字段 | |
---|---|
name |
仅限输出。IndexEndpoint 的资源名称。格式: |
display_name |
可选。IndexEndpoint 的显示名称。最多可包含 32 个字符。 |
description |
可选。IndexEndpoint 的说明。长度不得超过 25,000 个字符。 |
deployed_index |
仅限输出。在此 IndexEndpoint 中部署的索引。 |
state |
仅限输出。IndexEndpoint 状态。 |
labels |
可选。应用于资源的标签必须符合以下要求:
如需了解详情,请参阅 Google Cloud 文档。 |
create_time |
仅限输出。创建时间戳。 |
update_time |
仅限输出。更新时间戳。 |
州
IndexEndpoint 阶段。
枚举 | |
---|---|
STATE_UNSPECIFIED |
默认值。不应使用。 |
CREATING |
状态为“正在创建”。 |
CREATED |
状态为“已创建”。 |
UPDATING |
状态为“UPDATING”。 |
FAILED |
状态为“失败”。 |
IndexedAsset
IndexedAsset 是索引的构建基础。
字段 | |
---|---|
index |
必需。此编入索引的素材资源所属的索引。格式: |
asset |
必需。资源的资源名称。格式: |
create_time |
仅限输出。创建时间戳。 |
update_time |
仅限输出。更新时间戳。 |
IndexingStatus
资产的索引编制状态。
字段 | |
---|---|
state |
仅限输出。此资产的索引编制状态。 |
status_message |
用于描述状态的详细消息。 |
州
此素材资源索引编制状态的枚举。
枚举 | |
---|---|
STATE_UNSPECIFIED |
默认进程状态绝不应发生。 |
IN_PROGRESS |
正在编入索引。 |
SUCCEEDED |
该流程已成功完成。 |
FAILED |
该流程失败。 |
IngestAssetRequest
IngestAsset API 的请求消息。
字段 | |
---|---|
联合字段
|
|
config |
提供数据的信息以及数据所属的资产资源名称。第一条 |
time_indexed_data |
要提取的数据。 |
配置
数据的配置。
字段 | |
---|---|
asset |
必需。提取的数据所属的资产的资源名称。 |
联合字段
|
|
video_type |
视频数据的类型信息。 |
VideoType
视频数据的类型信息。
字段 | |
---|---|
container_format |
视频数据的容器格式。 |
ContainerFormat
视频的容器格式。
枚举 | |
---|---|
CONTAINER_FORMAT_UNSPECIFIED |
默认类型,不应使用。 |
CONTAINER_FORMAT_MP4 |
Mp4 容器格式。 |
TimeIndexedData
包含数据以及相应的数据所涵盖的时间范围。
字段 | |
---|---|
data |
要提取的数据。 |
temporal_partition |
数据的时间范围。 |
IngestAssetResponse
IngestAsset API 的响应消息。
字段 | |
---|---|
successfully_ingested_partition |
已成功提取的数据的时间范围。 |
实例
用于描述实例对象的消息
字段 | |
---|---|
name |
仅输出。资源名称 |
create_time |
仅限输出。[仅限输出] 创建时间戳 |
update_time |
仅限输出。[仅限输出] 更新时间戳 |
labels |
标签作为键值对 |
display_name |
必需。解决方案的易记显示名称。 |
description |
此实例的说明。 |
instance_type |
当前实例的实例类型。 |
input_resources[] |
当前应用实例的输入资源。例如:input_resources: visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/stream-a |
output_resources[] |
与一个应用实例关联的所有输出资源。 |
state |
实例的状态。 |
InputResource
在一个应用实例中使用的输入资源的消息。
字段 | |
---|---|
consumer_node |
接收输入资源的图节点的名称。例如:input_resource: visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a consumer_node: stream-input |
input_resource_binding |
如果只有 1 个输入绑定,则可以忽略将使用当前输入资源的特定输入资源绑定。 |
annotations |
包含资源注解。 |
联合字段 input_resource_information 。必需。指定应用实例的输入。input_resource_information 只能是下列其中一项: |
|
input_resource |
直接输入资源名称。如果实例类型为 STREAMING_PREDICTION,输入资源的格式为“projects/123/locations/us-central1/clusters/456/streams/stream-a”。如果实例类型为 Cloud Storage 输入容器中的 BATCH_PREDICTION,则输入资源的格式为“gs://bucket-a”。 |
annotated_stream |
如果输入资源是 VisionAI 数据流,则可以改用 annotated_stream 指定关联的注释。 |
OutputResource
在一个应用实例中使用的输出资源的消息。
字段 | |
---|---|
output_resource |
当前应用实例的输出资源名称。 |
producer_node |
生成输出资源名称的图节点的名称。例如:output_resource: /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting producer_node: occupancy-counting |
output_resource_binding |
用于生成当前 OutputResource 的特定输出资源绑定。 |
is_temporary |
仅限输出。输出资源是否为临时资源,这意味着资源是在部署应用期间生成的。在应用解部署期间,系统会删除临时资源。 |
autogen |
仅限输出。输出资源是由 Vision AI App Platform 自动创建的。 |
州
实例状态
枚举 | |
---|---|
STATE_UNSPECIFIED |
默认值。如果省略状态,则使用此值。 |
CREATING |
状态为“正在创建”。 |
CREATED |
状态为“已创建”。 |
DEPLOYING |
状态为 DEPLOYING。 |
DEPLOYED |
状态为“已部署”。 |
UNDEPLOYING |
状态为 UNDEPLOYING。 |
DELETED |
状态为“已删除”。 |
ERROR |
状态 ERROR。 |
UPDATING |
状态更新 |
DELETING |
状态:正在删除。 |
FIXING |
状态修复。 |
IntRange
整数范围类型。
字段 | |
---|---|
start |
int 范围的起始值。 |
end |
int 范围的结束值。 |
IntRangeArray
整数范围值的列表。
字段 | |
---|---|
int_ranges[] |
整数范围值。 |
ListAnalysesRequest
用于请求分析列表的消息
字段 | |
---|---|
parent |
必需。ListAnalysesRequest 的父级值 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器会选择相应的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果 |
order_by |
有关如何对结果进行排序的提示 |
ListAnalysesResponse
对列出分析的响应消息
字段 | |
---|---|
analyses[] |
“分析”列表 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListAnnotationsRequest
GetAnnotation API 的请求消息。
字段 | |
---|---|
parent |
拥有此注解集合的父级。格式: |
page_size |
要返回的注释数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 条注释。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
从之前的 进行分页时,提供给 |
filter |
应用于返回列表的过滤条件。我们仅支持对以下字段进行过滤: |
ListAnnotationsResponse
ListAnnotations API 的请求消息。
字段 | |
---|---|
annotations[] |
指定素材资源中的注释。 |
next_page_token |
可作为 |
ListApplicationsRequest
用于请求应用列表的消息。
字段 | |
---|---|
parent |
必需。ListApplicationsRequest 的父级值。 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器会选择相应的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果。 |
order_by |
有关如何对结果进行排序的提示。 |
ListApplicationsResponse
对列出应用的响应消息。
字段 | |
---|---|
applications[] |
应用列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListAssetsRequest
ListAssets 的请求消息。
字段 | |
---|---|
parent |
必需。拥有此素材资源集合的父级。格式: |
page_size |
要返回的资产数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 个素材资源。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
从之前的 进行分页时,提供给 |
filter |
应用于返回列表的过滤条件。仅支持以下过滤条件:“assets_with_contents = true”,用于返回已上传内容的资产;“assets_with_contents = false”,用于返回没有内容的资产。 |
ListAssetsResponse
ListAssets 的响应消息。
字段 | |
---|---|
assets[] |
指定语料库中的资源。 |
next_page_token |
可作为 |
ListCollectionsRequest
ListCollections 的请求消息。
字段 | |
---|---|
parent |
必需。父语料库。格式: |
page_size |
要返回的集合数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 个合集。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
从之前的 进行分页时,提供给 |
ListCollectionsResponse
ListCollections 的响应消息。
字段 | |
---|---|
collections[] |
指定语料库中的集合。 |
next_page_token |
可作为 |
ListCorporaRequest
ListCorpora 的请求消息。
字段 | |
---|---|
parent |
必需。要列出其语料库的项目的资源名称。 |
page_size |
请求的页面大小。 API 返回的结果可能少于请求的结果。如果为负数,则会返回 INVALID_ARGUMENT 错误。如果未指定或为 0,API 将选择默认大小(即 10)。如果请求的每页数据大小大于上限,API 将选择使用上限(即 20)。 |
page_token |
标识服务器要返回的结果页面的令牌。通常通过上一个 |
filter |
应用于返回的语料库列表的过滤条件。仅支持以下限制: |
ListCorporaResponse
ListCorpora 的响应消息。
字段 | |
---|---|
corpora[] |
项目中的语料库。 |
next_page_token |
用于检索下一页结果的令牌。传递给 |
ListDataSchemasRequest
ListDataSchemas 的请求消息。
字段 | |
---|---|
parent |
必需。拥有此数据架构集合的父级。格式: |
page_size |
要返回的数据架构的数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 个数据架构。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
从之前的 进行分页时,提供给 |
ListDataSchemasResponse
ListDataSchemas 的响应消息。
字段 | |
---|---|
data_schemas[] |
指定语料库中的数据架构。 |
next_page_token |
可作为 |
ListDraftsRequest
用于请求草稿列表的消息。
字段 | |
---|---|
parent |
必需。ListDraftsRequest 的父级值。 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器会选择相应的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果。 |
order_by |
有关如何对结果进行排序的提示。 |
ListDraftsResponse
对列出草稿的响应消息。
字段 | |
---|---|
drafts[] |
草稿列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListIndexEndpointsRequest
ListIndexEndpoints 的请求消息。
字段 | |
---|---|
parent |
必需。格式: |
page_size |
可选。请求的页面大小。 服务器返回的项可能要比请求的少。服务返回的值可能小于此值。如果未指定,则使用每页 50 个数据的大小。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
可选。标识服务器应返回的结果页面的令牌。 |
filter |
可选。应用于返回列表的过滤条件。我们仅支持对 |
ListIndexEndpointsResponse
ListIndexEndpoints 的响应消息。
字段 | |
---|---|
index_endpoints[] |
IndexEndpoint 列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
ListIndexesRequest
用于列出索引的请求消息。
字段 | |
---|---|
parent |
必需。拥有此索引集合的父级语料库。格式:projects/{project_number}/locations/{location}/corpora/{corpus} |
page_size |
要返回的索引的最大数量。服务返回的值可能小于此值。如果未指定,则最多返回 50 个索引。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
从之前的 进行分页时,提供给 |
ListIndexesResponse
ListIndexes 的响应消息。
字段 | |
---|---|
indexes[] |
指定语料库下的索引。 |
next_page_token |
可作为 |
ListInstancesRequest
用于请求实例列表的消息。
字段 | |
---|---|
parent |
必需。ListInstancesRequest 的父级值。 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器会选择相应的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果。 |
order_by |
有关如何对结果进行排序的提示。 |
ListInstancesResponse
对列出实例的响应消息。
字段 | |
---|---|
instances[] |
实例列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListPrebuiltProcessorsRequest
用于列出预构建处理器的请求消息。
字段 | |
---|---|
parent |
必需。父路径。 |
ListPrebuiltProcessorsResponse
用于列出预构建处理器的响应消息。
字段 | |
---|---|
processors[] |
处理器列表。 |
ListProcessesRequest
用于请求进程列表的消息。
字段 | |
---|---|
parent |
必需。ListProcessesRequest 的父级值。 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器会选择相应的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果 |
order_by |
有关如何对结果进行排序的提示 |
ListProcessesResponse
对列出进程的响应消息。
字段 | |
---|---|
processes[] |
进程列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListProcessorsRequest
用于请求处理器列表的消息。
字段 | |
---|---|
parent |
必需。ListProcessorsRequest 的父级值。 |
page_size |
请求的页面大小。 服务器返回的项可能要比请求的少。如果未指定,服务器会选择相应的默认值。 |
page_token |
标识服务器应返回的结果页面的令牌。 |
filter |
过滤结果。 |
order_by |
有关如何对结果进行排序的提示。 |
ListProcessorsResponse
对列出处理器的响应消息。
字段 | |
---|---|
processors[] |
处理器列表。 |
next_page_token |
标识服务器应返回的结果页面的令牌。 |
unreachable[] |
无法到达的位置。 |
ListSearchConfigsRequest
ListSearchConfigs 的请求消息。
字段 | |
---|---|
parent |
必需。拥有此搜索配置集合的父级。格式: |
page_size |
要返回的搜索配置的最大数量。服务返回的值可能小于此值。如果未指定,则使用每页 50 个数据的大小。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
从之前的 进行分页时,提供给 |
ListSearchConfigsResponse
ListSearchConfigs 的响应消息。
字段 | |
---|---|
search_configs[] |
指定语料库中的搜索配置。 |
next_page_token |
可作为 |
ListSearchHypernymsRequest
用于列出 SearchHypernym 的请求消息。
字段 | |
---|---|
parent |
必需。拥有此 SearchHypernym 集合的父级。格式: |
page_size |
返回的 SearchHypernym 的数量上限。服务返回的值可能小于此值。如果未指定,则使用每页 50 个数据的大小。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
从之前的 进行分页时,提供给 |
ListSearchHypernymsResponse
用于列出 SearchHypernym 的响应消息。
字段 | |
---|---|
search_hypernyms[] |
指定语料库中的 SearchHypernym。 |
next_page_token |
可作为 |
MachineSpec
单台机器的规范。
字段 | |
---|---|
machine_type |
不可变。机器的类型。 请参阅支持自定义训练的机器类型列表。 对于 [DeployedModel][],此字段是可选字段,默认值为 |
accelerator_type |
不可变。根据 |
accelerator_count |
要挂接到机器的加速器数量。 |
MediaWarehouseConfig
用于描述 MediaWarehouseConfig 的消息。
字段 | |
---|---|
corpus |
Media Warehouse 语料库的资源名称。格式:projects/${project_id}/locations/${location_id}/corpora/${corpus_id} |
region |
已弃用。 |
ttl |
所有媒体资产、关联的元数据和搜索文档的有效期。 |
ModelType
Vision AI App Platform 中支持的所有模型类型。
枚举 | |
---|---|
MODEL_TYPE_UNSPECIFIED |
处理器类型:UNSPECIFIED。 |
IMAGE_CLASSIFICATION |
模型类型:图片分类。 |
OBJECT_DETECTION |
模型类型:对象检测。 |
VIDEO_CLASSIFICATION |
模型类型:视频分类。 |
VIDEO_OBJECT_TRACKING |
模型类型:对象跟踪。 |
VIDEO_ACTION_RECOGNITION |
模型类型:动作识别。 |
OCCUPANCY_COUNTING |
模型类型占用情况统计。 |
PERSON_BLUR |
模型类型:人物模糊处理。 |
VERTEX_CUSTOM |
模型类型为 Vertex 自定义。 |
节点
用于描述节点对象的消息。
字段 | |
---|---|
name |
必需。节点的唯一名称。 |
display_name |
节点的易记显示名称。 |
node_config |
节点配置。 |
processor |
处理器名称是指所选的处理器资源。 |
parents[] |
父节点。输入节点不应具有父节点。对于 V1 Alpha1/Beta 版,只有媒体仓库节点可以有多个父级,其他类型的节点只能有一个父级。 |
联合字段
|
|
output_all_output_channels_to_stream |
默认情况下,节点的输出仅可供下游节点使用。如需使用应用节点的直接输出,必须先将输出发送到 Vision AI Streams。 通过将 output_all_output_channels_to_stream 设置为 true,App Platform 会自动将当前节点的所有输出发送到 Vision AI 数据流资源(每个输出通道一个数据流)。输出流资源将由 App Platform 在部署期间自动创建,并在应用取消部署后删除。请注意,此配置适用于所有应用实例。 您可以通过配置实例资源的 |
InputEdge
消息,用于描述指向某个节点的边。
字段 | |
---|---|
parent_node |
父节点的名称。 |
parent_output_channel |
父节点的已连接输出工件。如果目标处理器只有 1 个输出工件,则可以省略此属性。 |
connected_input_channel |
当前节点处理器的已连接输入通道。如果目标处理器只有 1 个输入通道,则可以忽略此参数。 |
NormalizedPolygon
规范化多边形。
字段 | |
---|---|
normalized_vertices[] |
外接多边形的规范化顶点。图片的左上角将为 [0, 0]。 |
NormalizedPolyline
归一化 Pplyline,表示由相连的直线段组成的曲线。
字段 | |
---|---|
normalized_vertices[] |
一系列由直线连接的顶点。 |
NormalizedVertex
顶点表示图片中的 2D 点。注意:标准化顶点坐标相对于原始图片,范围介于 0 和 1 之间。
字段 | |
---|---|
x |
x 坐标。 |
y |
y 坐标。 |
ObjectDetectionPredictionResult
通用对象检测的预测输出格式。
字段 | |
---|---|
current_time |
当前时间戳。 |
identified_boxes[] |
已识别出的盒子的列表。 |
实体
对象检测预测结果中的注释的实体信息。
字段 | |
---|---|
label_id |
标签 ID。 |
label_string |
标签的直观易懂的字符串。 |
IdentifiedBox
已识别出的框包含对象的位置和实体。
字段 | |
---|---|
box_id |
此框的唯一 ID。 |
normalized_bounding_box |
规范化坐标中的边界框。 |
confidence_score |
与此框关联的置信度分数。 |
entity |
此框的实体。 |
NormalizedBoundingBox
规范化坐标中的边界框。
字段 | |
---|---|
xmin |
x 坐标中的最小值。 |
ymin |
y 坐标中的最小值。 |
width |
边界框的宽度。 |
height |
边界框的高度。 |
OccupancyCountConfig
用于说明 OccupancyCountConfig 的消息。
字段 | |
---|---|
enable_people_counting |
无论是统计人物出镜次数,还是输出统计次数,键均为“people”。 |
enable_vehicle_counting |
无论是否要统计车辆出现次数,输出计数都将使用“vehicle”作为键。 |
enable_dwelling_time_tracking |
是否跟踪每个个别对象在场景或特定区域内的逗留时间。 |
OccupancyCountingPredictionResult
用于统计人数的预测结果 proto。
字段 | |
---|---|
current_time |
当前时间戳。 |
identified_boxes[] |
已识别出的盒子的列表。 |
stats |
检测统计信息。 |
track_info[] |
跟踪相关信息。在此时间戳时有效的所有轨道。只有在启用跟踪功能时,此字段才会存在。 |
dwell_time_info[] |
与逗留时间相关的信息。在给定区域内播放的所有轨道,以及相应的开始和结束停留时间时间戳 |
DwellTimeInfo
来自客流量统计运营商的注释的逗留时间信息。
字段 | |
---|---|
track_id |
用于标识曲目的唯一 ID。它应在各个帧中保持一致。 |
zone_id |
对象所在的区域的唯一 ID。 |
dwell_start_time |
在某个区域内识别出住宅对象的开始时间。 |
dwell_end_time |
住宅对象离开某个区域的结束时间。 |
实体
来自占用人数统计运算符的注释的实体信息。
字段 | |
---|---|
label_id |
标签 ID。 |
label_string |
标签的直观易懂的字符串。 |
IdentifiedBox
已识别出的框包含对象的位置和实体。
字段 | |
---|---|
box_id |
此框的唯一 ID。 |
normalized_bounding_box |
规范化坐标中的边界框。 |
score |
与此框关联的置信度分数。 |
entity |
此框的实体。 |
track_id |
用于标识曲目的唯一 ID。它应在各个帧中保持一致。只有在启用跟踪功能时,此字段才会存在。 |
NormalizedBoundingBox
规范化坐标中的边界框。
字段 | |
---|---|
xmin |
x 坐标中的最小值。 |
ymin |
y 坐标中的最小值。 |
width |
边界框的宽度。 |
height |
边界框的高度。 |
统计信息
来自占用情况统计运算符的注释的统计信息。
字段 | |
---|---|
full_frame_count[] |
全帧的计数。 |
crossing_line_counts[] |
越线次数。 |
active_zone_counts[] |
活跃区间的计数。 |
AccumulatedObjectCount
来自占用情况统计运算符的注解的对象信息和累计计数。
字段 | |
---|---|
start_time |
累计计数的开始时间。 |
object_count |
累计计数的对象数。 |
ActiveZoneCount
活跃区间数消息。
字段 | |
---|---|
annotation |
用户提供的有效区域注释。 |
counts[] |
相应区域内的计数。 |
CrossingLineCount
关于越线次数的消息。
字段 | |
---|---|
annotation |
来自用户的线条注释。 |
positive_direction_counts[] |
遵循右手规则的方向。 |
negative_direction_counts[] |
与右手定则相反的方向。 |
accumulated_positive_direction_counts[] |
累计正例数。 |
accumulated_negative_direction_counts[] |
累计的负数计数。 |
ObjectCount
来自占用情况统计运算符的注释的对象信息和即时计数。
字段 | |
---|---|
entity |
此对象的实体。 |
count |
对象的数量。 |
TrackInfo
来自占用人数统计运算符的注释的轨道信息。
字段 | |
---|---|
track_id |
用于标识曲目的唯一 ID。它应在各个帧中保持一致。 |
start_time |
此轨道的开始时间戳。 |
OperationMetadata
表示长时间运行的操作的元数据。
字段 | |
---|---|
create_time |
仅供输出。操作的创建时间。 |
end_time |
仅供输出。操作完成运行的时间。 |
target |
仅限输出。由服务器定义的操作目标的资源路径。 |
verb |
仅限输出。操作执行的谓词的名称。 |
status_message |
仅限输出。人类可读的操作状态(如果有)。 |
requested_cancellation |
仅限输出。标识用户是否已请求取消操作。已成功取消的操作具有 [Operation.error][] 值且 |
api_version |
仅限输出。用于启动操作的 API 版本。 |
分区
分区,用于指定子资产级注释的时间和空间分区。
字段 | |
---|---|
temporal_partition |
按时间对资产进行分区。 |
spatial_partition |
空间中资产的分区。 |
relative_temporal_partition |
按时间对资产进行分区。 |
RelativeTemporalPartition
按相对时间对资产进行分区。受 VIDEO_ON_DEMAND 语料库类型支持。
字段 | |
---|---|
start_offset |
分区的开始时间偏移量。 |
end_offset |
分区的结束时间偏移量。 |
SpatialPartition
空间中资产的分区。
字段 | |
---|---|
x_min |
最小 x 坐标值。 |
y_min |
最小 y 坐标值。 |
x_max |
最大 x 坐标值。 |
y_max |
最大 y 坐标值。 |
TemporalPartition
资产的分区,采用世界协调时间 (UTC) 纪元时间。STREAM_VIDEO 语料库类型支持此属性。
字段 | |
---|---|
start_time |
分区的开始时间。 |
end_time |
分区的结束时间。 |
PersonBlurConfig
用于描述 FaceBlurConfig 的消息。
字段 | |
---|---|
person_blur_type |
人物模糊处理类型。 |
faces_only |
是否仅在处理器中模糊处理人脸,而不模糊处理整个对象。 |
PersonBlurType
人物模糊处理类型
枚举 | |
---|---|
PERSON_BLUR_TYPE_UNSPECIFIED |
人脸模糊处理类型为“UNSPECIFIED”。 |
FULL_OCCULUSION |
脸部模糊处理类型:完全遮盖。 |
BLUR_FILTER |
FaceBlur 类型模糊处理滤镜。 |
PersonVehicleDetectionConfig
用于描述 PersonVehicleDetectionConfig 的消息。
字段 | |
---|---|
enable_people_counting |
enable_people_counting 和 enable_vehicle_counting 字段中至少有一个必须设置为 true。无论是统计人物出镜次数,还是输出统计次数,键均为“people”。 |
enable_vehicle_counting |
无论是否要统计车辆出现次数,输出计数都将使用“vehicle”作为键。 |
PersonalProtectiveEquipmentDetectionConfig
用于描述 PersonalProtectiveEquipmentDetectionConfig 的消息。
字段 | |
---|---|
enable_face_coverage_detection |
是否启用人脸遮挡检测。 |
enable_head_coverage_detection |
是否启用头部遮盖检测。 |
enable_hands_coverage_detection |
是否启用手掌覆盖检测。 |
PersonalProtectiveEquipmentDetectionOutput
个人防护用品检测运算符的输出格式。
字段 | |
---|---|
current_time |
当前时间戳。 |
detected_persons[] |
DetectedPerson 列表。 |
DetectedPerson
Detected Person 包含检测到的人员及其关联的 PPE 和保护信息。
字段 | |
---|---|
person_id |
检测到的人的 ID。 |
detected_person_identified_box |
检测到的人脸识别框中的信息。 |
detected_ppe_identified_boxes[] |
与检测到的人员相关联的 PPE 标识框的信息。 |
face_coverage_score |
每个身体部位的覆盖率得分。人脸的覆盖率得分。 |
eyes_coverage_score |
眼睛的覆盖率得分。 |
head_coverage_score |
标题的覆盖率得分。 |
hands_coverage_score |
手的覆盖率得分。 |
body_coverage_score |
正文的覆盖率得分。 |
feet_coverage_score |
脚的覆盖率得分。 |
NormalizedBoundingBox
规范化坐标中的边界框。
字段 | |
---|---|
xmin |
x 坐标中的最小值。 |
ymin |
y 坐标中的最小值。 |
width |
边界框的宽度。 |
height |
边界框的高度。 |
PPEEntity
PPE 检测预测结果中的注释的实体信息。
字段 | |
---|---|
ppe_label_id |
标签 ID。 |
ppe_label_string |
标签的直观易懂的字符串(例如:头盔、手套、口罩)。 |
ppe_supercategory_label_string |
超级类别标签的直观易懂的字符串(示例:head_cover、hands_cover、face_cover)。 |
ppe_entity_id |
实体 ID。 |
PPEIdentifiedBox
PPEIdentified 框包含个人防护用品的地理位置和实体信息。
字段 | |
---|---|
box_id |
此框的唯一 ID。 |
normalized_bounding_box |
规范化坐标中的边界框。 |
confidence_score |
与此框关联的置信度分数。 |
ppe_entity |
PPE 实体信息。 |
PersonEntity
人脸检测预测结果中的注释的实体信息。
字段 | |
---|---|
person_entity_id |
实体 ID。 |
PersonIdentifiedBox
“已识别出人物”框包含相应人物的位置信息和实体信息。
字段 | |
---|---|
box_id |
此框的唯一 ID。 |
normalized_bounding_box |
规范化坐标中的边界框。 |
confidence_score |
与此框关联的置信度分数。 |
person_entity |
人员实体信息。 |
流程
用于描述 Process 对象的消息。
字段 | |
---|---|
name |
资源的名称。 |
create_time |
仅限输出。创建时间戳。 |
update_time |
仅限输出。更新时间戳。 |
analysis |
必需。对现有分析资源的引用。 |
attribute_overrides[] |
可选。分析器的属性替换项。每个替换项的格式为:“{analyzer_name}:{attribute_key}={value}” |
run_status |
可选。流程状态。 |
run_mode |
可选。进程的运行模式。 |
event_id |
可选。输入/输出数据流的事件 ID。如果分析中包含 StreamSource/StreamSink 运算符,并且您想手动指定要读取/写入的事件,此方法非常有用。 |
处理器
用于描述 Processor 对象的消息。下一个 ID:19
字段 | |
---|---|
name |
资源的名称。 |
create_time |
仅限输出。[仅限输出] 创建时间戳。 |
update_time |
仅限输出。[仅限输出] 更新时间戳。 |
labels |
标签以键值对的形式提供。 |
display_name |
必需。处理器的易记显示名称。 |
description |
用于描述处理器功能的示例句子。 |
processor_type |
仅限输出。处理器类型。 |
model_type |
型号类型。 |
custom_processor_source_info |
客户创建的处理器的来源信息。 |
state |
仅限输出。处理器的状态。 |
processor_io_spec |
仅限输出。[仅输出] 处理器的输入 / 输出规范,每种类型的处理器都有固定的输入 / 输出规范,客户无法更改。 |
configuration_typeurl |
仅限输出。您可以在应用中使用相应的配置来自定义处理器的行为。 |
supported_annotation_types[] |
|
supports_post_processing |
指示处理器是否支持后处理。 |
ProcessorState
枚举 | |
---|---|
PROCESSOR_STATE_UNSPECIFIED |
未指定处理器状态。 |
CREATING |
正在创建处理器(尚无法使用)。 |
ACTIVE |
处理器已准备就绪,可以使用。 |
DELETING |
正在删除处理器(无法使用)。 |
FAILED |
处理器已被删除或创建失败。 |
ProcessorType
类型
枚举 | |
---|---|
PROCESSOR_TYPE_UNSPECIFIED |
处理器类型:UNSPECIFIED。 |
PRETRAINED |
处理器类型为预训练。预训练处理器由 Vision AI App Platform 开发,具有最先进的视觉数据处理功能,例如人数统计或人物模糊处理。预训练处理器通常是公开的。 |
CUSTOM |
处理器类型为“自定义”。自定义处理器是指由客户上传或从其他 Google Cloud 平台(例如 Vertex AI)导入的专用处理器。自定义处理器仅对创建者可见。 |
CONNECTOR |
处理器类型 CONNECTOR。连接器处理器是专门为应用执行 I/O 的处理器,它们不会处理数据,而是将数据传送给其他处理器或从其他处理器接收数据。 |
ProcessorConfig
下一个 ID:28
字段 | |
---|---|
联合字段
|
|
video_stream_input_config |
数据流输入处理器的配置。 |
ai_enabled_devices_input_config |
支持 AI 的输入设备的配置。 |
media_warehouse_config |
媒体仓库处理器的配置。 |
person_blur_config |
人像模糊处理器的配置。 |
occupancy_count_config |
入住人数统计处理器的配置。 |
person_vehicle_detection_config |
人员车辆检测处理器的配置。 |
vertex_automl_vision_config |
Vertex AutoML Vision 处理器的配置。 |
vertex_automl_video_config |
Vertex AutoML 视频处理器的配置。 |
vertex_custom_config |
Vertex 自定义处理器的配置。 |
general_object_detection_config |
常规对象检测处理器的配置。 |
big_query_config |
BigQuery 处理器的配置。 |
personal_protective_equipment_detection_config |
personal_protective_equipment_detection_config 的配置 |
ProcessorIOSpec
用于说明处理器输入 / 输出规范的消息。
字段 | |
---|---|
graph_input_channel_specs[] |
对于具有 input_channel_specs 的处理器,必须明确将该处理器连接到另一个处理器。 |
graph_output_channel_specs[] |
当前处理器的输出工件规范。 |
instance_resource_input_binding_specs[] |
需要从应用实例馈送的输入资源。 |
instance_resource_output_binding_specs[] |
处理器将为每个实例生成的输出资源。除了此处明确列出的输出绑定之外,所有处理器的 GraphOutputChannel 都可以绑定到流式传输资源。然后,绑定名称与 GraphOutputChannel 的名称相同。 |
GraphInputChannelSpec
输入通道规范消息。
字段 | |
---|---|
name |
当前输入频道的名称。 |
data_type |
当前输入通道的数据类型。如果此字段有多个值,则表示此输入渠道可以连接到这两种不同数据类型中的任一类型。 |
accepted_data_type_uris[] |
如果已指定,则只有这些详细数据类型才能与处理器相关联。例如,对于 MEDIA 类型,使用 jpeg 流;对于 PROTO 类型,使用 PredictionResult proto。如果未指定,则接受任何协议。 |
required |
处理器是否需要当前输入通道。例如,对于具有必需视频输入和可选音频输入的处理器,如果缺少视频输入,则系统会拒绝申请;但只要存在视频输入,则可以缺少音频输入。 |
max_connection_allowed |
可以连接到此输入通道的输入边数。0 表示无限制。 |
GraphOutputChannelSpec
输出渠道规范消息。
字段 | |
---|---|
name |
当前输出渠道的名称。 |
data_type |
当前输出通道的数据类型。 |
data_type_uri |
|
InstanceResourceInputBindingSpec
实例资源渠道规范消息。外部资源是指未在应用图中表示的虚拟节点。每个处理器都会表达其外图规范,因此客户可以替换外部来源或目的地
字段 | |
---|---|
name |
输入绑定的名称,在处理器中是唯一的。 |
联合字段
|
|
config_type_uri |
包含 Googleapis 资源的配置 proto。例如 type.googleapis.com/google.cloud.vision.v1.StreamWithAnnotation |
resource_type_uri |
Googleapis 资源的直接类型网址,例如 type.googleapis.com/google.cloud.vision.v1.Asset |
InstanceResourceOutputBindingSpec
字段 | |
---|---|
name |
输出绑定的名称,在处理器中是唯一的。 |
resource_type_uri |
可接受的输出资源的资源类型 URI。 |
explicit |
是否需要在实例中明确设置输出资源。如果为 false,则处理器会根据需要自动生成它。 |
RemoveApplicationStreamInputRequest
用于从应用中移除串流输入的消息。
字段 | |
---|---|
name |
必需。要检索的应用的名称。格式:“projects/{project}/locations/{location}/applications/{application}” |
target_stream_inputs[] |
要移除的目标数据流。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
TargetStreamInput
有关要移除的目标 streamInput 的消息。
字段 | |
---|---|
stream |
|
RemoveApplicationStreamInputResponse
此类型没有字段。
RemoveApplicationStreamInput 响应的消息。
RemoveCollectionItemRequest
RemoveCollectionItem 的请求消息。
字段 | |
---|---|
item |
必需。要移除的内容。 |
RemoveCollectionItemResponse
RemoveCollectionItem 的请求消息。
字段 | |
---|---|
item |
已移除的项。 |
RemoveIndexAssetMetadata
RemoveIndexAsset 的元数据。
字段 | |
---|---|
indexing_status |
此资产的索引编制状态。 |
start_time |
操作的开始时间。 |
update_time |
操作的更新时间。 |
RemoveIndexAssetRequest
RemoveIndexAsset 的请求消息。
字段 | |
---|---|
name |
必需。要编入索引的资产的资源名称。格式: |
index |
可选。索引的名称。格式: |
RemoveIndexAssetResponse
此类型没有字段。
RemoveIndexAsset 的响应消息。
RemoveRetailProductsFromRetailProductSetResponse
操作完成后的 RemoveRetailProductsFromRetailProductSet 响应。
ResourceAnnotations
说明资源一般注释的消息。
字段 | |
---|---|
application_annotations[] |
将应用于整个应用的注释。 |
node_annotations[] |
将应用于应用的特定节点的注解。如果将同一类型的注解同时应用于应用和节点,除了全局应用注解之外,系统还会添加节点注解。例如,如果整个应用有一个活跃区域注解,而占用情况分析处理器有一个活跃区域注解,则占用情况分析处理器将定义两个活跃区域。 |
RetailBatchAnalyzeResponse
针对 BatchAnalyze 的响应消息。
RetailEntity
实体可以是标记文本中的短语或数字。它是一种已知的实体类型,例如商品名、常规价格或会员价格。
字段 | |
---|---|
type |
实体类型,例如“商品名”“常规价格”“会员价格”。 |
mention_text |
实体的文本值,例如“2.99 美元”。如果代码中不存在相应实体,此字段将为空。 |
confidence |
实体预测的置信度。 |
region |
代码区域中实体的位置区域。 |
normalized_text_value |
实体类型的预定义标准中的标准化文本值。如果无法转换提取的值,则为 null。 |
RetailNormalizedBoundingBox
边界框坐标相对于图片的宽度和高度。例如,如果图片的尺寸为 100x200,且 NormalizedBoundingBox 为 <xmin = 0.1 xmax = 0.5 ymin = 0.2 ymax = 0.9>,则边界框坐标将介于 (10, 40) 和 (50, 180) 之间。请注意,边界框的部分可能超出图片范围。
字段 | |
---|---|
x_min |
左上角的水平坐标。 |
x_max |
右下角的水平坐标。 |
y_min |
左上角的垂直坐标。 |
y_max |
右下角的垂直坐标。 |
RetailObjectDetectionAnnotation
描述图片中的对象区域及其检测注释。
字段 | |
---|---|
bounding_box |
对象实例的标准化边界框。 |
confidence |
置信度分数介于 0.0 和 1.0 之间。值越高,对结果的置信度就越高。 |
RetailOperationMetadata
零售服务的操作元数据。
字段 | |
---|---|
operation_metadata |
长时间运行的操作的常见元数据。 |
partial_failures[] |
仅限输出。遇到的部分失败。例如,无法读取单个图片文件。状态详细信息字段将包含标准 Google Cloud 错误详情。 |
operation_metrics |
仅限输出。有关操作的指标。 |
OperationMetrics
有关该操作的记录指标。
字段 | |
---|---|
counters |
从计数器名称到计数的映射。 |
RetailPredictResults
BatchAnalyze 的结果格式。
字段 | |
---|---|
image_uri |
输入的图片 URI。 |
product_recognition_annotations[] |
商品识别注释。 |
tag_recognition_annotations[] |
标记识别注释。 |
RetailProduct
表示 RetailProduct 资源的消息。
字段 | |
---|---|
name |
仅限输出。RetailProduct 资源的名称。 |
gtins[] |
商品的全球贸易项目代码 (GTIN)。 |
normalized_gtins[] |
仅限输出。将输入的 GTIN 转换为规范化 GTIN-14 格式的标准化版本。 |
third_party_ids[] |
零售商或制造商使用的第三方标识符。 |
locale |
商品信息的语言区域,以 BCP-47 代码表示,例如 en-US、de-DE。商品标签和品牌的语言应与语言区域的语言一致。 |
brand |
商品的本地化品牌。 |
title |
商品的本地化名称。 |
product_uri |
商品的着陆页。 |
resource_state |
仅限输出。RetailProduct 的状态。 |
labels |
带有用户定义元数据的标签,用于整理 RetailProduct。 标签键和值不能超过 64 个字符(Unicode 代码点),并且只能包含小写字母、数字字符、下划线和短划线。允许使用国际字符。 |
create_time |
仅限输出。创建时间戳。 |
update_time |
仅限输出。更新时间戳。 |
RetailProductImageSimilarity
与索引集中的商品图片的相似度得分。
字段 | |
---|---|
visual_similarity_score |
与此商品图片的相似度得分。 |
detected_text_similarity_score |
查询商品图片中检测到的文本与此商品图片中模型检测到的文本之间的相似度得分。 |
product_title_text_similarity_score |
查询商品图片中检测到的文本与此商品图片的人工编辑商品名之间的相似度得分。 |
similarity_score |
与此商品图片的最终综合相似度得分。 |
RetailProductRecognitionAnnotation
描述图片中的商品区域及其商品识别注释。
字段 | |
---|---|
product_region |
此商品实例的检测信息(边界框、置信度等)。 |
recognition_results[] |
商品识别结果。这些结果会按置信度从高到低的顺序排序。 |
detected_text |
模型在此 product_region 中检测到的文字。 |
RetailProductRecognitionResult
单件商品识别结果。
字段 | |
---|---|
product_metadata |
识别出的商品的元数据。 |
confidence |
置信度分数介于 0.0 和 1.0 之间。值越高,对结果的置信度就越高。 |
image_similarity[] |
此结果中每个商品图片的相似度分数详情。 |
RetailResourceState
资源的状态。
枚举 | |
---|---|
RETAIL_RESOURCE_STATE_UNSPECIFIED |
默认值。不应使用。 |
RETAIL_RESOURCE_STATE_CREATING |
状态为“正在创建”。 |
RETAIL_RESOURCE_STATE_CREATED |
状态为“已创建”。 |
RETAIL_RESOURCE_STATE_UPDATING |
状态为“UPDATING”。 |
RETAIL_RESOURCE_STATE_DELETED |
状态为“已删除”。 |
RETAIL_RESOURCE_STATE_ERROR |
状态 ERROR。 |
RetailTagRecognitionAnnotation
proto 用于描述标签的识别结果,包括此标签实例占据的图片区域和提取的文本信息。
字段 | |
---|---|
tag_region |
与此代码实例相关的检测信息(边界框、置信度等)。 |
tag_text |
此代码实例中的文本。 |
entities[] |
在代码中检测到的实体列表。 |
RetailThirdPartyId
表示零售商或制造商使用的第三方标识符(例如SKU 或 MPN)。
字段 | |
---|---|
id |
零售商或制造商使用的第三方 ID(例如SKU 或 MPN)。 |
owner |
“拥有”第三方标识符的实体,即销售此商品的制造商或零售商。 |
RunMode
RunMode 表示启动进程的模式。
枚举 | |
---|---|
RUN_MODE_UNSPECIFIED |
模式未指定。 |
LIVE |
直播模式。这意味着,系统会启动该进程来处理直播视频源,并且可能会丢失数据包。 |
SUBMISSION |
提交模式。这意味着,进程会启动以处理边界视频文件,且不会丢包。跟踪完成状态。 |
RunStatus
用于描述进程状态的消息。
字段 | |
---|---|
state |
进程的状态。 |
reason |
成为该状态的原因。 |
州
State 表示进程的运行状态。
枚举 | |
---|---|
STATE_UNSPECIFIED |
状态未指定。 |
INITIALIZING |
INITIALIZING 表示进程已调度,但尚未准备好处理真实流量。 |
RUNNING |
RUNNING 表示进程正在运行并处理流量。 |
COMPLETED |
COMPLETED 表示进程已完成处理,尤其是对于非流式传输用例。 |
FAILED |
FAILED 表示进程未能完成处理。 |
SchemaKeySortingStrategy
用于指定如何按数据架构键进行排序的策略。
字段 | |
---|---|
options[] |
前面的选项的优先级高于后面的选项。 |
选项
用于一个数据架构键的选项。
字段 | |
---|---|
data_schema_key |
用于排序的数据。 |
sort_decreasing |
是按降序还是升序排序。默认情况下,结果会按升序排列。 |
aggregate_method |
当前数据架构键的汇总方法。 |
AggregateMethod
如果一个结果具有多个具有相同键的值,请指定要用于排序的值。默认情况下,如果结果按降序排序,则使用 AGGREGATE_METHOD_LARGEST;如果结果按升序排序,则使用 AGGREGATE_METHOD_SMALLEST。
枚举 | |
---|---|
AGGREGATE_METHOD_UNSPECIFIED |
未指定的汇总方法将被覆盖,如上所述。 |
AGGREGATE_METHOD_LARGEST |
取最大(字典顺序或数值)值进行排序。 |
AGGREGATE_METHOD_SMALLEST |
取最小(字典顺序或数字)值进行排序。 |
SearchAssetsRequest
SearchAssets 的请求消息。
字段 | |
---|---|
corpus |
必需。要搜索的父语料库。格式为 `projects/{project_id}/locations/{location_id}/corpora/{corpus_id}' |
page_size |
此页面中返回的结果数。如果为 0,则服务器将决定适当的 page_size。 |
page_token |
用于提取下一页的接续令牌。如果为空,则表示正在提取第一页。 |
content_time_ranges |
匹配的视频内容必须位于的时间范围。如果未提供任何范围,则表示没有时间限制。此字段的处理方式与以下条件相同,但由于此字段使用频率较高,因此单独进行了定义。请注意,如果 end_time 是未来时间,则会被截断为收到请求的时间。 |
criteria[] |
应用于搜索结果的条件。 |
exclusion_criteria[] |
要从搜索结果中排除的条件。请注意,系统会忽略 |
facet_selections[] |
存储最近的细分选择状态。此处仅会显示包含用户所选内容的细分组。选择状态为“已选择”或“未选择”。只有所选的分面分桶才会用作搜索条件。 |
result_annotation_keys[] |
注释键列表,用于指定要检索并随每个搜索结果一起返回的注释。注释精细程度必须为 GRANULARITY_ASSET_LEVEL,且其搜索策略不得为 NO_SEARCH。 |
search_query |
全球搜索查询。允许用户搜索素材资源,而无需指定值属于哪个字段。 |
联合字段 sort_spec 。排序规范。如果未指定此字段,则默认:- STREAM_VIDEO:搜索结果按开始时间排序。sort_spec 只能是下列其中一项: |
|
schema_key_sorting_strategy |
按数据架构键下的值进行排序。 |
SearchAssetsResponse
SearchAssets 的响应消息。
字段 | |
---|---|
search_result_items[] |
返回的搜索结果。 |
next_page_token |
下一页的接续令牌。 |
facet_results[] |
给定查询的构面搜索结果,其中包含用户已选择的构面值和更新后的构面搜索结果。 |
SearchCapability
搜索功能的功能和元数据。
字段 | |
---|---|
type |
要启用的搜索功能。 |
类型
能够对素材资源执行不同的搜索。
枚举 | |
---|---|
TYPE_UNSPECIFIED |
未指定的搜索功能,切勿使用。 |
EMBEDDING_SEARCH |
嵌入搜索。 |
SearchCapabilitySetting
用于启用搜索功能的设置。
字段 | |
---|---|
search_capabilities[] |
要启用的搜索功能的元数据。 |
SearchConfig
SearchConfig 会存储会影响搜索行为和搜索结果的不同属性。
字段 | |
---|---|
name |
搜索配置的资源名称。对于 CustomSearchCriteria,search_config 是搜索运算符名称。对于分面,search_config 是分面维度名称。格式: |
facet_property |
建立 FacetDimension 和相关规范。 |
search_criteria_property |
在自定义 SearchCriteria 与一个或多个 UGA 键之间创建映射。 |
SearchCriteriaProperty
自定义搜索条件的集中配置。
字段 | |
---|---|
mapped_fields[] |
每个 mapped_field 对应于一个 UGA 键。如需了解此属性的运作方式,请参考以下示例。在 SearchConfig 表中,用户添加了以下条目:search_config { name: "person" search_criteria_property { mapped_fields: "player" mapped_fields: "coach" } } 现在,当用户发出如下查询时: criteria { field: "person" text_array { txt_values: "Tom Brady" txt_values: "Bill Belichick" } } MWH 搜索将返回满足以下条件的搜索文档:(player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick)。 |
SearchHypernym
搜索资源:SearchHypernym。例如,{ hypernym: "vehicle" hyponyms: ["sedan", "truck"] }。这意味着,在 SMART_SEARCH 模式下,搜索“vehicle”还会返回将“sedan”或“truck”作为注释的结果。
字段 | |
---|---|
name |
SearchHypernym 的资源名称。格式: |
hypernym |
上位词。 |
hyponyms[] |
该超词根映射到的同义词。 |
SearchIndexEndpointRequest
SearchIndexEndpoint 的请求消息。
字段 | |
---|---|
index_endpoint |
必需。要搜索的索引端点。格式:`projects/{project_id}/locations/{location_id}/indexEndpoints/{index_endpoint_id}' |
criteria[] |
应用于搜索结果的条件。 |
exclusion_criteria[] |
要从搜索结果中排除的条件。请注意,系统会忽略 |
page_size |
请求的页面大小。 API 返回的结果可能少于请求的结果。如果为负数,则会返回 INVALID_ARGUMENT 错误。如果未指定或为 0,API 将选择默认大小(即 10)。如果请求的每页数据大小大于上限,API 将选择上限(即 100)。 |
page_token |
用于提取下一页的接续令牌。如果为空,则表示正在提取第一页。 |
联合字段 query 。oneof 全局搜索查询。query 只能是下列其中一项: |
|
image_query |
仅查询图片。 |
text_query |
纯文本查询。 |
SearchIndexEndpointResponse
SearchIndexEndpoint 的响应消息。
字段 | |
---|---|
search_result_items[] |
返回的搜索结果。 |
next_page_token |
下一页的接续令牌。如果省略此字段,则不存在后续页面。 |
SearchResultItem
搜索结果包含资产名称和相应的时间范围。
字段 | |
---|---|
asset |
资源的资源名称。格式: |
segments[] |
匹配的素材资源细分。已废弃:请使用单数形式的 |
segment |
匹配的素材资源细分。 |
relevance |
此 |
requested_annotations[] |
搜索请求中通过 result_annotation_keys 指定的搜索结果注释。 |
annotation_matching_results[] |
与此搜索结果项相关联的基于条件或基于构面选择的注释匹配结果。仅包含 fetch_matched_annotations=true 的 criteria 或 facet_selection 的结果。 |
StreamAnnotation
关于 Vision AI 数据流资源注释的消息。
字段 | |
---|---|
id |
注释的 ID。在特定上下文中使用时,必须是唯一的。例如,Vision AI 应用的一个输入流的所有注释。 |
display_name |
注释的易记名称。 |
source_stream |
Vision AI 数据流资源名称。 |
type |
注释的实际类型。 |
联合字段
|
|
active_zone |
适用于类型 ACTIVE_ZONE 的注释 |
crossing_line |
类型为 CROSSING_LINE 的注释 |
StreamAnnotationType
用于描述所有可能的串流注释类型的枚举。
枚举 | |
---|---|
STREAM_ANNOTATION_TYPE_UNSPECIFIED |
类型为“UNSPECIFIED”。 |
STREAM_ANNOTATION_TYPE_ACTIVE_ZONE |
active_zone 注释会在基于图片/视频的流内容上定义一个多边形,之后的处理将仅关注活跃区域内的内容。 |
STREAM_ANNOTATION_TYPE_CROSSING_LINE |
crossing_line 注释会在基于图片/视频的 Vision AI 数据流的内容上定义多段线,系统会捕获线条上发生的事件。例如,在客流分析处理器中,跨越线条的人数。 |
StreamAnnotations
重复的 StreamAnnotation 的封装容器。
字段 | |
---|---|
stream_annotations[] |
多个注释。 |
StreamWithAnnotation
消息,用于描述包含应用专用注释的 Vision AI 数据流。此消息中的所有 StreamAnnotation 对象都必须具有唯一 ID。
字段 | |
---|---|
stream |
Vision AI 数据流资源名称。 |
application_annotations[] |
将应用于整个应用的注释。 |
node_annotations[] |
将应用于应用的特定节点的注解。如果将同一类型的注解同时应用于应用和节点,除了全局应用注解之外,系统还会添加节点注解。例如,如果整个应用有一个活跃区域注解,而占用情况分析处理器有一个活跃区域注解,则占用情况分析处理器将定义两个活跃区域。 |
NodeAnnotation
用于描述应用节点专用注解的消息。
字段 | |
---|---|
node |
应用图的节点名称。 |
annotations[] |
节点专用数据流注释。 |
StringArray
字符串类型值的列表。
字段 | |
---|---|
txt_values[] |
字符串类型值。 |
UndeployApplicationRequest
用于取消部署应用的消息。
字段 | |
---|---|
name |
必需。要检索的应用的名称。格式:“projects/{project}/locations/{location}/applications/{application}” |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
UndeployApplicationResponse
UndeployApplication 响应消息。
UndeployIndexMetadata
UndeployIndex 的元数据消息。
字段 | |
---|---|
operation_metadata |
长时间运行的操作的常见元数据。 |
deployed_index |
仅限输出。要取消部署的索引。 |
UndeployIndexRequest
UndeployIndexEndpoint 的请求消息。
字段 | |
---|---|
index_endpoint |
必需。要取消部署的 IndexEndpoint 资源的资源名称。格式: |
UndeployIndexResponse
此类型没有字段。
操作完成后的 UndeployIndex 响应。
UndeployRetailProductRecognitionIndexResponse
UndeployRetailProductRecognitionIndex 响应消息。
UpdateAnalysisRequest
用于更新分析的消息。
字段 | |
---|---|
update_mask |
必需。字段掩码用于指定更新将在 Analysis 资源中覆盖的字段。update_mask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。如果用户未提供掩码,则所有字段都会被覆盖。 |
analysis |
必需。要更新的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
UpdateAnnotationRequest
UpdateAnnotation API 的请求消息。
字段 | |
---|---|
annotation |
必需。要更新的注释。注解的 |
update_mask |
要更新的字段的列表。 |
UpdateApplicationInstancesRequest
用于更新 ApplicationInstance 的消息。
字段 | |
---|---|
name |
必需。要检索的应用的名称。格式:“projects/{project}/locations/{location}/applications/{application}” |
application_instances[] |
|
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
allow_missing |
如果为 true,则当目标资源不存在时,更新请求将创建一个资源,此时系统会忽略 field_mask。 |
UpdateApplicationInstance
字段 | |
---|---|
update_mask |
可选。字段掩码用于指定更新将在 Draft 资源中覆盖的字段。update_mask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。如果用户未提供掩码,则所有字段都会被覆盖。 |
instance |
必需。要更新的资源。 |
instance_id |
必需。实例的 ID。 |
UpdateApplicationInstancesResponse
UpdateApplicationInstances 响应消息。
UpdateApplicationRequest
更新应用的消息。
字段 | |
---|---|
update_mask |
可选。字段掩码用于指定更新将在 Application 资源中覆盖的字段。update_mask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。如果用户未提供掩码,则所有字段都会被覆盖。 |
application |
必需。要更新的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
UpdateApplicationStreamInputRequest
用于更新应用的流输入的消息。
字段 | |
---|---|
name |
必需。要检索的应用的名称。格式:“projects/{project}/locations/{location}/applications/{application}” |
application_stream_inputs[] |
要更新的数据流输入,数据流资源名称是每个 StreamInput 的键,并且在每个应用中都必须是唯一的。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
allow_missing |
如果为 true,UpdateApplicationStreamInput 将向应用插入数据流输入,即使应用中不包含目标数据流也是如此。 |
UpdateApplicationStreamInputResponse
AddApplicationStreamInput 响应消息。
UpdateAssetRequest
UpdateAsset 的请求消息。
字段 | |
---|---|
asset |
必需。要更新的资产。 资产的 |
update_mask |
要更新的字段的列表。 |
UpdateCollectionRequest
UpdateCollectionRequest 的请求消息。
字段 | |
---|---|
collection |
必需。要更新的集合。 集合的 |
update_mask |
要更新的字段的列表。- 取消设置 |
UpdateCorpusRequest
UpdateCorpus 的请求消息。
字段 | |
---|---|
corpus |
必需。用于替换服务器上资源的语料库。 |
update_mask |
要更新的字段的列表。 |
UpdateDataSchemaRequest
UpdateDataSchema 的请求消息。
字段 | |
---|---|
data_schema |
必需。数据架构的 |
update_mask |
要更新的字段的列表。 |
UpdateDraftRequest
用于更新草稿的消息。
字段 | |
---|---|
update_mask |
可选。字段掩码用于指定更新将在 Draft 资源中覆盖的字段。update_mask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。如果用户未提供掩码,则所有字段都会被覆盖。 |
draft |
必需。要更新的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
allow_missing |
如果为 true,则当目标资源不存在时,UpdateDraftRequest 将创建一个资源,此时系统会忽略 field_mask。 |
UpdateIndexEndpointMetadata
UpdateIndexEndpoint 的元数据消息。
字段 | |
---|---|
operation_metadata |
长时间运行的操作的常见元数据。 |
UpdateIndexEndpointRequest
UpdateIndexEndpoint 的请求消息。
字段 | |
---|---|
index_endpoint |
必需。要更新的资源。 |
update_mask |
必需。字段掩码用于指定更新将在 IndexEndpoint 资源中覆盖的字段。update_mask 中指定的字段与资源相关,而不是与完整请求相关。如果资源的字段在掩码中,则会被覆盖。字段掩码不得为空。如果掩码为“*”,则表示完全替换资源。 |
UpdateIndexMetadata
UpdateIndexRequest 的元数据消息
字段 | |
---|---|
operation_metadata |
长时间运行的操作的常见元数据。 |
UpdateIndexRequest
UpdateIndex 的请求消息。
字段 | |
---|---|
index |
必需。要更新的资源。 |
update_mask |
必需。字段掩码用于指定更新将在 Index 资源中覆盖的字段。update_mask 中指定的字段与资源相关,而不是与完整请求相关。如果资源的字段在掩码中,则会被覆盖。字段掩码不得为空。如果掩码为“*”,则会触发对索引的完整更新,以及对索引数据的完整重建。 |
UpdateProcessRequest
用于更新进程的消息。
字段 | |
---|---|
update_mask |
必需。字段掩码用于指定更新将在 Process 资源中覆盖的字段。update_mask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。如果用户未提供掩码,则所有字段都会被覆盖。 |
process |
必需。要更新的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
UpdateProcessorRequest
用于更新处理器的消息。
字段 | |
---|---|
update_mask |
可选。字段掩码用于指定更新将在 Processor 资源中覆盖的字段。update_mask 中指定的字段与资源相关,而不是与完整请求相关。如果字段在掩码中,则会被覆盖。如果用户未提供掩码,则所有字段都会被覆盖。 |
processor |
必需。要更新的资源。 |
request_id |
可选。用于标识请求的可选请求 ID。您可以指定一个唯一的请求 ID,这样,在您必须重试请求时,服务器就会知道忽略该请求(如果该请求已完成)。服务器至少可以保证在第一次完成该请求后的 60 分钟内避免重复处理该请求。 例如,假设在您最初发出一个请求后,该请求超时,然后您使用相同的请求 ID 再次发出该请求,那么服务器便可检查是否收到了最初那个具有该请求 ID 的操作。如果收到了,服务器便会忽略这第二个请求。这样可以防止客户端意外创建重复的承诺。 请求 ID 必须是有效的 UUID,且不支持全部由零组成的 UUID(即 00000000-0000-0000-0000-000000000000)。 |
UpdateSearchConfigRequest
UpdateSearchConfig 的请求消息。
字段 | |
---|---|
search_config |
必需。要更新的搜索配置。 搜索配置的 |
update_mask |
要更新的字段的列表。如果未设置,系统会更新/覆盖所有字段路径。 |
UpdateSearchHypernymRequest
用于更新 SearchHypernym 的请求消息。
字段 | |
---|---|
search_hypernym |
必需。要更新的 SearchHypernym。搜索超同义词的 |
update_mask |
要更新的字段的列表。如果未设置,系统会更新/覆盖所有字段路径。 |
UploadAssetMetadata
UploadAsset 的元数据。
字段 | |
---|---|
start_time |
操作的开始时间。 |
update_time |
操作的更新时间。 |
UploadAssetRequest
UploadAsset 的请求消息。
字段 | |
---|---|
name |
必需。要上传的素材资源的资源名称。格式: |
asset_source |
资产的来源。 |
UploadAssetResponse
此类型没有字段。
UploadAsset 的响应消息。
UserSpecifiedAnnotation
用户提供的注释。
字段 | |
---|---|
key |
必需。注解的键。必须通过 CreateDataSchema 设置键的类型。 |
value |
注释的值。该值必须能够根据数据架构转换为该类型。 |
partition |
子资产级注释的时间和空间分区信息。 |
VertexAutoMLVideoConfig
用于描述 VertexAutoMLVideoConfig 的消息。
字段 | |
---|---|
confidence_threshold |
系统将仅返回得分高于阈值的实体。值 0.0 表示返回所有检测到的实体。 |
blocked_labels[] |
系统不会返回此字段中指定的标签。 |
max_predictions |
每个输出帧最多可返回这么多预测。值 0 表示返回所有检测到的实体。 |
bounding_box_size_limit |
系统只会返回大小大于此上限的边界框。仅限对象跟踪。值 0.0 表示返回所有检测到的实体。 |
VertexAutoMLVisionConfig
Vertex AutoML Vision 处理器配置消息。
字段 | |
---|---|
confidence_threshold |
系统将仅返回得分高于阈值的实体。值 0.0 表示返回所有检测到的实体。 |
max_predictions |
每个输出帧最多可返回这么多预测。值 0 表示返回所有检测到的实体。 |
VertexCustomConfig
用于描述 VertexCustomConfig 的消息。
字段 | |
---|---|
max_prediction_fps |
每秒最大预测帧数。此属性用于设置运算符向 Vertex AI 端点发送预测请求的速度。默认值为 0,表示没有预测 FPS 上限。运营商以输入 fps 发送预测请求。 |
dedicated_resources |
专门用于 DeployedModel 且需要更高程度的手动配置的资源的说明。 |
post_processing_cloud_function |
如果不为空,系统会将预测结果发送到指定的 Cloud Functions 函数进行后处理。* Cloud Functions 函数将收到 AppPlatformCloudFunctionRequest,其中 annotations 字段将采用 proto PredictResponse 的 JSON 格式。* Cloud Functions 函数应返回 AppPlatformCloudFunctionResponse,并将 PredictResponse 存储在 annotations 字段中。* 如需丢弃预测输出,只需清除返回的 AppPlatformCloudFunctionResponse 中的载荷字段即可。 |
attach_application_metadata |
如果为 true,自定义模型收到的预测请求还将包含采用以下架构的元数据:'appPlatformMetadata': { 'ingestionTime': DOUBLE; (UNIX timestamp) 'application': STRING; 'instanceId': STRING; 'node': STRING; 'processor': STRING; } |
VideoActionRecognitionPredictionResult
视频动作识别的预测输出格式。
字段 | |
---|---|
segment_start_time |
已标识操作的视频片段的开始时间(包括此时间)。 |
segment_end_time |
已识别出操作的视频片段的结束时间(包括该时间)。具体而言,如果结束时间与开始时间相同,则表示识别发生在特定视频帧上。 |
actions[] |
在指定时间范围内识别到的所有操作。 |
IdentifiedAction
每个 IdentifiedAction 都是使用 AnnotationSpec id、display_name 和关联的置信度得分指定的操作的特定标识。
字段 | |
---|---|
id |
已识别的 AnnotationSpec 的资源 ID。 |
display_name |
已识别的 AnnotationSpec 的显示名称。 |
confidence |
模型对此标识更正的置信度,值越高,置信度越高。 |
VideoClassificationPredictionResult
视频分类的预测输出格式。
字段 | |
---|---|
segment_start_time |
已确定分类的视频片段的开始时间(包括该时间)。 |
segment_end_time |
已确定分类的视频时间段的结束时间(包括该时间)。具体而言,如果结束时间与开始时间相同,则表示识别发生在特定视频帧上。 |
classifications[] |
在相应时间范围内识别的所有分类。 |
IdentifiedClassification
每个 IdentifiedClassification 都是使用 AnnotationSpec id 和 display_name 以及关联的置信度得分指定的分类的一种特定标识。
字段 | |
---|---|
id |
已识别的 AnnotationSpec 的资源 ID。 |
display_name |
已识别的 AnnotationSpec 的显示名称。 |
confidence |
模型对此标识更正的置信度,值越高,置信度越高。 |
VideoObjectTrackingPredictionResult
视频对象跟踪的预测输出格式。
字段 | |
---|---|
segment_start_time |
当前识别发生的视频片段的开始时间(包括该时间)。 |
segment_end_time |
当前识别发生的视频时间段的结束时间(包括该时间)。具体而言,如果结束时间与开始时间相同,则表示识别发生在特定视频帧上。 |
objects[] |
在指定时间范围内检测到的所有对象。 |
BoundingBox
检测到的对象的边界框。即视频帧上方用于指明找到的 AnnotationSpec 的矩形。坐标相对于帧大小,其中点 (0,0) 位于帧的左上角。
字段 | |
---|---|
x_min |
边界框的最左侧坐标。 |
x_max |
边界框的最右坐标。 |
y_min |
边界框的顶部坐标。 |
y_max |
边界框的底部坐标。 |
DetectedObject
每个 DetectedObject 都是使用 AnnotationSpec ID 和 display_name、边界框、关联的置信度得分和相应的 track_id 指定的对象的特定标识。
字段 | |
---|---|
id |
已识别的 AnnotationSpec 的资源 ID。 |
display_name |
已识别的 AnnotationSpec 的显示名称。 |
bounding_box |
边界框。 |
confidence |
模型对此标识更正的置信度,值越高,置信度越高。 |
track_id |
系统可能会在多个典型的相邻帧中识别出同一对象。检测到特定对象的一组帧构成了轨迹。此 track_id 可用于跟踪检测到的对象的所有帧。 |
VideoStreamInputConfig
用于描述视频流输入配置的消息。此消息应仅用作 builtin:stream-input 处理器的占位符,实际的流绑定应使用相应的 API 指定。
字段 | |
---|---|
streams[] |
|
streams_with_annotation[] |
ViewCollectionItemsRequest
ViewCollectionItems 的请求消息。
字段 | |
---|---|
collection |
必需。要查看的集合。格式: |
page_size |
要返回的集合数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 个合集。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
从之前的 进行分页时,提供给 |
ViewCollectionItemsResponse
ViewCollectionItems 的响应消息。
字段 | |
---|---|
items[] |
指定合集中的内容。 |
next_page_token |
可作为 |
ViewIndexedAssetsRequest
ViewIndexedAssets 的请求消息。
字段 | |
---|---|
index |
必需。拥有此素材资源集合的索引。格式: |
page_size |
要返回的资产数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 个素材资源。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。 |
page_token |
从之前的 进行分页时,提供给 |
filter |
应用于返回列表的过滤条件。仅支持以下过滤条件:“asset_id = xxxx”,用于返回指定 ID 的素材资源。“asset_id = xxxx, yyyy, zzzz”,用于返回具有指定 ID 的素材资源。 |
ViewIndexedAssetsResponse
ViewIndexedAssets 的响应消息。
字段 | |
---|---|
indexed_assets[] |
指定索引中的素材资源。 |
next_page_token |
可作为 |
WatchEventsRequest
WatchEventsRequest 包含观看器标识信息以及观看器感兴趣的事件的过滤条件。
字段 | |
---|---|
cluster |
资源的父级。 |
watcher_id |
唯一 ID 用于标识直播的观看者。 |
streams[] |
要观看的直播或直播集的名称。 |
event_update_filter |
监视器可以使用此过滤条件指定要接收哪些事件更新。 |
heartbeat_interval_second |
HeartbeatIntervalSecond 用于定义从 gRPC 流式传输服务器返回的心跳响应间隔(以秒为单位)。默认值 0 表示不会返回任何心跳。 |
WatchEventsResponse
每条响应消息都将包含一条事件更新。
字段 | |
---|---|
update_type |
事件更新的类型。 |
stream |
事件所附加的直播的名称。 |
event |
事件的名称。 |
series |
系列图书的名称。 |
update_time |
事件更新发生的时间戳。 |