ServerCatalogApi (GitHub Copilot SDK :: Java 1.0.16 API)

java.lang.Object

com.github.copilot.generated.rpc.ServerCatalogApi

@Generated("copilot-sdk-codegen") public final class ServerCatalogApi extends Object

API methods for the catalog namespace.

Since:: 1.0.0

Method Summary

Modifier and Type

Method

Description

CompletableFuture<CatalogSearchResult>

search(CatalogSearchParams params)

A bounded catalog search.

CompletableFuture<CatalogSearchResult>

search(CatalogSearchRequest request)

A bounded catalog search.

CompletableFuture<CatalogSelectionResult>

select(CatalogSelectParams params)

Terminates one retained catalog selection group through an opaque reference previously returned by the model-safe search projection.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- search
  
  @CopilotExperimental public CompletableFuture<CatalogSearchResult> search(CatalogSearchParams params)
  
  A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan.
  
  Since:
  
  1.0.0
- search
  
  @CopilotExperimental public CompletableFuture<CatalogSearchResult> search(CatalogSearchRequest request)
  
  A bounded catalog search. Both the query length and the result count are capped by the schema so a caller cannot request an unbounded scan.
  Accepts the extensible request, including inputs added after the params record.
  
  Since:
  
  1.0.0
- select
  
  @CopilotExperimental public CompletableFuture<CatalogSelectionResult> select(CatalogSelectParams params)
  
  Terminates one retained catalog selection group through an opaque reference previously returned by the model-safe search projection.
  
  Since:
  
  1.0.0