Class Ai<AiModelList>Abstract

constructor

• new Ai<AiModelList extends AiModelListType = AiModels>(): Ai<AiModelList>

  Type Parameters

  • AiModelList extends AiModelListType = AiModels

  Returns Ai<AiModelList>

aiGatewayLogId

aiSearch

• aiSearch(): AiSearchNamespace

  Returns AiSearchNamespace

  Deprecated

  Use the standalone ai_search_namespaces or ai_search Workers bindings instead. See https://developers.cloudflare.com/ai-search/usage/workers-binding/

autorag

• autorag(autoragId: string): AutoRAG

  Parameters

  • autoragId: string

    Instance ID

  Returns AutoRAG

  Deprecated

  AutoRAG has been replaced by AI Search. Use the standalone ai_search_namespaces or ai_search Workers bindings instead. See https://developers.cloudflare.com/ai-search/usage/workers-binding/

gateway

• gateway(gatewayId: string): AiGateway

  Parameters

  • gatewayId: string

  Returns AiGateway

models

• models(params?: AiModelsSearchParams): Promise<AiModelsSearchObject[]>

  Parameters

  • Optionalparams: AiModelsSearchParams

  Returns Promise<AiModelsSearchObject[]>

run

• run<Name extends string | number | symbol>(
      model: Name,
      inputs: { requests: AiModelList[Name]["inputs"][] },
      options: AiOptions & { queueRequest: true },
  ): Promise<AiAsyncBatchResponse>

  Type Parameters

  • Name extends string | number | symbol

  Parameters

  • model: Name
  • inputs: { requests: AiModelList[Name]["inputs"][] }
  • options: AiOptions & { queueRequest: true }

  Returns Promise<AiAsyncBatchResponse>

• run<Name extends string | number | symbol>(
      model: Name,
      inputs: AiModelList[Name]["inputs"],
      options: AiOptions & { returnRawResponse: true },
  ): Promise<Response>

  Type Parameters

  • Name extends string | number | symbol

  Parameters

  • model: Name
  • inputs: AiModelList[Name]["inputs"]
  • options: AiOptions & { returnRawResponse: true }

  Returns Promise<Response>

• run<Name extends string | number | symbol>(
      model: Name,
      inputs: AiModelList[Name]["inputs"],
      options: AiOptions & { websocket: true },
  ): Promise<Response>

  Type Parameters

  • Name extends string | number | symbol

  Parameters

  • model: Name
  • inputs: AiModelList[Name]["inputs"]
  • options: AiOptions & { websocket: true }

  Returns Promise<Response>

• run<Name extends string | number | symbol>(
      model: Name,
      inputs: AiModelList[Name]["inputs"] & { stream: true },
      options?: AiOptions,
  ): Promise<ReadableStream<any>>

  Type Parameters

  • Name extends string | number | symbol

  Parameters

  • model: Name
  • inputs: AiModelList[Name]["inputs"] & { stream: true }
  • Optionaloptions: AiOptions

  Returns Promise<ReadableStream<any>>

• run<Name extends string | number | symbol>(
      model: Name,
      inputs: AiModelList[Name]["inputs"],
      options?: AiOptions,
  ): Promise<AiModelList[Name]["postProcessedOutputs"]>

  Type Parameters

  • Name extends string | number | symbol

  Parameters

  • model: Name
  • inputs: AiModelList[Name]["inputs"]
  • Optionaloptions: AiOptions

  Returns Promise<AiModelList[Name]["postProcessedOutputs"]>

• run<Model extends string>(
      model: Model extends keyof AiModelList ? never : Model,
      inputs: Record<string, unknown>,
      options?: AiOptions,
  ): Promise<Record<string, unknown>>

  Type Parameters

  • Model extends string

  Parameters

  • model: Model extends keyof AiModelList ? never : Model
  • inputs: Record<string, unknown>
  • Optionaloptions: AiOptions

  Returns Promise<Record<string, unknown>>

toMarkdown

• toMarkdown(): ToMarkdownService

  Returns ToMarkdownService

• toMarkdown(
      files: MarkdownDocument[],
      options?: ConversionRequestOptions,
  ): Promise<ConversionResponse[]>

  Parameters

  • files: MarkdownDocument[]
  • Optionaloptions: ConversionRequestOptions

  Returns Promise<ConversionResponse[]>

• toMarkdown(
      files: MarkdownDocument,
      options?: ConversionRequestOptions,
  ): Promise<ConversionResponse>

  Parameters

  • files: MarkdownDocument
  • Optionaloptions: ConversionRequestOptions

  Returns Promise<ConversionResponse>

websearch

• websearch(request: AiWebSearchRequest): Promise<Response>

  Parameters

  • request: AiWebSearchRequest

  Returns Promise<Response>